Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Sep 11, 2010, 12:34:00 AM (14 years ago)
Author:
landauf
Message:

merged doc branch back to trunk

Location:
code/trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • code/trunk

  • code/trunk/src/orxonox/worldentities/WorldEntity.cc

    r7163 r7401  
    267267    @brief
    268268        Attaches this object to a parent SceneNode.
    269     @Remarks
     269    @remarks
    270270        Only use this method if you know exactly what you're doing!
    271271        Normally, attaching works internally by attaching WE's.
    … …  
    282282    @brief
    283283        Detaches this object from a parent SceneNode.
    284     @Remarks
     284    @remarks
    285285        Only use this method if you know exactly what you're doing!
    286286        Normally, attaching works internally by attaching WE's.
    … …  
    355355        Attaches a child WorldEntity to this object. This calls notifyBeingAttached()
    356356        of the child WE.
    357     @Note
     357    @note
    358358        The collision shape of the child object gets attached nevertheless. That also means
    359359        that you can change the collision shape of the child and it correctly cascadeds the changes to this instance.
    … …  
    628628    @brief
    629629        Sets the three dimensional scaling of this object.
    630     @Note
     630    @note
    631631        Scaling physical objects has not yet been implemented and is therefore forbidden.
    632632    */
    … …  
    650650    @brief
    651651        Translates this WorldEntity by a vector.
     652    @param distance
     653        The relative distance of the translation
    652654    @param relativeTo
    653         @see WorldEntity::TransformSpace
     655        The TransformSpace of this translation
    654656    */
    655657    void WorldEntity::translate(const Vector3& distance, TransformSpace relativeTo)
    … …  
    678680    @brief
    679681        Rotates this WorldEntity by a quaternion.
     682    @param rotation
     683        The desired relative rotation
    680684    @param relativeTo
    681         @see WorldEntity::TransformSpace
     685        The TransformSpace of this translation
    682686    */
    683687    void WorldEntity::rotate(const Quaternion& rotation, TransformSpace relativeTo)
    … …  
    703707    @brief
    704708        Makes this WorldEntity look at a specific target location.
     709    @param target
     710        An absolute point in the space which defines the direction of the entity
    705711    @param relativeTo
    706         @see WorldEntity::TransformSpace
     712        The TransformSpace of this translation
    707713    @param localDirectionVector
    708714        The vector which normally describes the natural direction of the object, usually -Z.
    … …  
    729735    @brief
    730736        Makes this WorldEntity look in specific direction.
     737    @param direction
     738        A point relative to the position of the WorldEntity which defines its orientation
    731739    @param relativeTo
    732         @see WorldEntity::TransformSpace
     740        The TransformSpace of this translation
    733741    @param localDirectionVector
    734742        The vector which normally describes the natural direction of the object, usually -Z.
    … …  
    773781    /**
    774782    @brief
    775         Sets the CollisionType. This alters the object significantly! @see CollisionType.
    776     @Note
     783        Sets the CollisionType. This alters the object significantly!
     784    @note
    777785        Operation does not work on attached WorldEntities.
    778786    */
    … …  
    900908        Recalculates the accumulated child mass and calls recalculateMassProps()
    901909        and notifies the parent of the change.
    902     @Note
     910    @note
    903911        Called by a child WE
    904912    */
    … …  
    919927    @brief
    920928        Undertakes the necessary steps to change the collision shape in Bullet, even at runtime.
    921     @Note
     929    @note
    922930        - called by this->collisionShape_
    923931        - May have a REALLY big overhead when called continuously at runtime, because then we need

  • code/trunk/src/orxonox/worldentities/WorldEntity.h

    r7163 r7401  
    299299            @brief
    300300                Returns the diagonal elements of the inertia tensor when calculated in local coordinates.
    301             @Note
     301            @note
    302302                The local inertia tensor cannot be set, but is calculated by Bullet according to the collisionShape.
    303303                With compound collision shapes, an approximation is used.
    … …  
    367367            @param otherObject
    368368                The object this one has collided into.
    369             @pram contactPoint
     369            @param contactPoint
    370370                Contact point provided by Bullet. Holds more information and can me modified. See return value.
    371             @Return
     371            @return
    372372                Returning false means that no modification to the contactPoint has been made. Return true otherwise!
    373             @Note
     373            @note
    374374                Condition is that enableCollisionCallback() was called.
    375375            */
Note: See TracChangeset for help on using the changeset viewer.