Gazebo Rendering

API Reference

3.7.2

Ogre2.x implementation of the Node class. More...

#include <Ogre2Node.hh>

Public Member Functions

virtual ~Ogre2Node ()
 Destructor. More...
 
virtual void Destroy () override
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...
 
virtual bool HasParent () const override
 Determine if this Node is attached to another Node. More...
 
virtual bool InheritScale () const override
 Determine if this visual inherits scale from this parent. More...
 
virtual math::Vector3d LocalScale () const override
 Get the local scale. More...
 
virtual Ogre::SceneNode * Node () const
 Get a pointer to the underlying scene node. More...
 
virtual NodePtr Parent () const override
 Get the parent Node. More...
 
virtual void SetInheritScale (bool _inherit) override
 Specify if this visual inherits scale from its parent. More...
 
- Public Member Functions inherited from BaseNode< Ogre2Object >
virtual ~BaseNode ()
 
virtual void AddChild (NodePtr _child) override
 Add the given node to this node. If the given node is already a child, no work will be done. More...
 
virtual NodePtr ChildById (unsigned int _id) const override
 Get node with given ID. If no child exists with given ID, NULL will be returned. More...
 
virtual NodePtr ChildByIndex (unsigned int _index) const override
 Get node at given index. If no child exists at given index, NULL will be returned. More...
 
virtual NodePtr ChildByName (const std::string &_name) const override
 Get node with given name. If no child exists with given name, NULL will be returned. More...
 
virtual unsigned int ChildCount () const override
 Get number of child nodes. More...
 
virtual bool HasChild (ConstNodePtr _child) const override
 Determine if given node is an attached child. More...
 
virtual bool HasChildId (unsigned int _id) const override
 Determine if node with given ID is an attached child. More...
 
virtual bool HasChildName (const std::string &_name) const override
 Determine if node with given name is an attached child. More...
 
virtual bool InheritScale () const override=0
 Determine if this visual inherits scale from this parent. More...
 
virtual math::Pose3d LocalPose () const override
 Get the local pose. More...
 
virtual math::Vector3d LocalPosition () const override
 Get the local position. More...
 
virtual math::Quaterniond LocalRotation () const override
 Get the local rotation. More...
 
virtual math::Vector3d LocalScale () const override=0
 Get the local scale. More...
 
virtual math::Vector3d Origin () const override
 Get position of origin. More...
 
virtual NodePtr Parent () const override=0
 Get the parent Node. More...
 
virtual void PreRender () override
 Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More...
 
virtual NodePtr RemoveChild (NodePtr _child) override
 Remove (detach) the given node from this node. If the given node is not a child of this node, no work will be done. More...
 
virtual NodePtr RemoveChildById (unsigned int _id) override
 Remove (detach) the node with the given ID from this node. If the specified node is not a child of this node, no work will be done. More...
 
virtual NodePtr RemoveChildByIndex (unsigned int _index) override
 Remove (detach) the node at the given index from this node. If the specified node is not a child of this node, no work will be done. More...
 
virtual NodePtr RemoveChildByName (const std::string &_name) override
 Remove (detach) the node with the given name from this node. If the specified node is not a child of this node, no work will be done. More...
 
virtual void RemoveChildren () override
 Remove all child nodes from this node This detaches all the child nodes but does not destroy them. More...
 
virtual void RemoveParent () override
 Detach this Node from its parent. If this Node does not have a parent, no work will be done. More...
 
virtual void Scale (const math::Vector3d &_scale) override
 Scale the current scale by the given scalars. More...
 
virtual void Scale (double _scale) override
 Scale the current scale by the given scalar. The given scalar will be assigned to the x, y, and z coordinates. More...
 
virtual void Scale (double _x, double _y, double _z) override
 Scale the current scale by the given scalars. More...
 
virtual void SetLocalPose (const math::Pose3d &_pose) override
 Set the local pose. More...
 
virtual void SetLocalPosition (const math::Vector3d &_position) override
 Set the local position. More...
 
virtual void SetLocalPosition (double _x, double _y, double _z) override
 Set the local position. More...
 
virtual void SetLocalRotation (const math::Quaterniond &_rotation) override
 Set the local rotation. More...
 
virtual void SetLocalRotation (double _r, double _p, double _y) override
 Set the local rotation. More...
 
virtual void SetLocalRotation (double _w, double _x, double _y, double _z) override
 Set the local rotation. More...
 
virtual void SetLocalScale (const math::Vector3d &_scale) override
 Set the local scale. More...
 
virtual void SetLocalScale (double _scale) override
 Set the local scale. The given scale will be assigned to the x, y, and z coordinates. More...
 
virtual void SetLocalScale (double _x, double _y, double _z) override
 Set the local scale. More...
 
virtual void SetOrigin (const math::Vector3d &_origin) override
 Set position of origin. The position should be relative to the original origin of the geometry. More...
 
virtual void SetOrigin (double _x, double _y, double _z) override
 Set position of origin. The position should be relative to the original origin of the geometry. More...
 
virtual void SetWorldPose (const math::Pose3d &_pose) override
 Set the world pose. More...
 
virtual void SetWorldPosition (const math::Vector3d &_position) override
 Set the world position. More...
 
virtual void SetWorldPosition (double _x, double _y, double _z) override
 Set the world position. More...
 
virtual void SetWorldRotation (const math::Quaterniond &_rotation) override
 Set the world rotation. More...
 
virtual void SetWorldRotation (double _r, double _p, double _y) override
 Set the world rotation. More...
 
virtual void SetWorldRotation (double _w, double _x, double _y, double _z) override
 Set the world rotation. More...
 
virtual void SetWorldScale (const math::Vector3d &_scale) override
 Set the world scale. More...
 
virtual void SetWorldScale (double _scale) override
 Set the world scale. The given scale will be assigned to the x, y, and z coordinates. More...
 
virtual void SetWorldScale (double _x, double _y, double _z) override
 Set the world scale. More...
 
virtual math::Pose3d WorldPose () const override
 Get the world pose. More...
 
virtual math::Vector3d WorldPosition () const override
 Get the world position. More...
 
virtual math::Quaterniond WorldRotation () const override
 Get the world rotation. More...
 
virtual math::Vector3d WorldScale () const override
 Get the world scale. More...
 
virtual math::Pose3d WorldToLocal (const math::Pose3d &_pose) const override
 Convert given world pose to local pose. More...
 
- Public Member Functions inherited from Node
virtual ~Node ()
 Deconstructor. More...
 
virtual unsigned int ChildCount () const =0
 Get number of child nodes. More...
 
virtual math::Pose3d LocalPose () const =0
 Get the local pose. More...
 
virtual math::Vector3d LocalPosition () const =0
 Get the local position. More...
 
virtual math::Quaterniond LocalRotation () const =0
 Get the local rotation. More...
 
virtual math::Vector3d Origin () const =0
 Get position of origin. More...
 
virtual math::Pose3d WorldPose () const =0
 Get the world pose. More...
 
virtual math::Vector3d WorldPosition () const =0
 Get the world position. More...
 
virtual math::Quaterniond WorldRotation () const =0
 Get the world rotation. More...
 
virtual math::Vector3d WorldScale () const =0
 Get the world scale. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. More...
 
virtual unsigned int Id () const =0
 Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
 
virtual std::string Name () const =0
 Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...
 
virtual void PostRender ()=0
 Post process this object and any of its children after rendering. More...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 
- Public Member Functions inherited from Ogre2Object
virtual ~Ogre2Object ()
 Destructor. More...
 
virtual ScenePtr Scene () const override
 
- Public Member Functions inherited from BaseObject
virtual ~BaseObject ()
 
virtual unsigned int Id () const override
 
virtual std::string Name () const override
 
virtual void PostRender () override
 

Protected Member Functions

 Ogre2Node ()
 Constructor. More...
 
virtual bool AttachChild (NodePtr _child) override
 
virtual NodeStorePtr Children () const override
 
virtual bool DetachChild (NodePtr _child) override
 
virtual void Init () override
 
virtual void Load () override
 
virtual math::Pose3d RawLocalPose () const override
 
virtual math::Vector3d RawLocalPosition () const
 Get the raw local position of the node. More...
 
virtual math::Quaterniond RawLocalRotation () const
 Get the raw local rotation of the node. More...
 
virtual void SetLocalScaleImpl (const math::Vector3d &_scale) override
 Implementation of the SetLocalScale function. More...
 
virtual void SetParent (Ogre2NodePtr _parent)
 Set the parent node. More...
 
virtual void SetRawLocalPose (const math::Pose3d &_Pose3d) override
 
virtual void SetRawLocalPosition (const math::Vector3d &_position)
 Set the raw local position of the node. More...
 
virtual void SetRawLocalRotation (const math::Quaterniond &_rotation)
 Set the raw local rotation of the node. More...
 
- Protected Member Functions inherited from BaseNode< Ogre2Object >
 BaseNode ()
 
virtual NodeStorePtr Children () const=0
 
virtual void PreRenderChildren ()
 
virtual math::Pose3d RawLocalPose () const=0
 
- Protected Member Functions inherited from Ogre2Object
 Ogre2Object ()
 Constructor. More...
 
- Protected Member Functions inherited from BaseObject
 BaseObject ()
 

Protected Attributes

Ogre2NodeStorePtr children
 A list of child nodes. More...
 
Ogre::SceneNode * ogreNode = nullptr
 The underlying ogre scene node. More...
 
Ogre2NodePtr parent
 Pointer to the parent ogre node. More...
 
- Protected Attributes inherited from BaseNode< Ogre2Object >
math::Vector3d origin
 
- Protected Attributes inherited from Ogre2Object
Ogre2ScenePtr scene
 Pointer to the ogre scene. More...
 
- Protected Attributes inherited from BaseObject
unsigned int id
 
std::string name
 

Detailed Description

Ogre2.x implementation of the Node class.

Constructor & Destructor Documentation

◆ Ogre2Node()

Ogre2Node ( )
protected

Constructor.

◆ ~Ogre2Node()

virtual ~Ogre2Node ( )
virtual

Destructor.

Member Function Documentation

◆ AttachChild()

virtual bool AttachChild ( NodePtr  _child)
overrideprotectedvirtual

◆ Children()

virtual NodeStorePtr Children ( ) const
overrideprotectedvirtual

◆ Destroy()

virtual void Destroy ( )
overridevirtual

Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.

Reimplemented from BaseNode< Ogre2Object >.

Reimplemented in Ogre2Camera, Ogre2Light, BaseVisual< Ogre2Node >, Ogre2GpuRays, and Ogre2ThermalCamera.

◆ DetachChild()

virtual bool DetachChild ( NodePtr  _child)
overrideprotectedvirtual

◆ HasParent()

virtual bool HasParent ( ) const
overridevirtual

Determine if this Node is attached to another Node.

Returns
True if this Node has a parent Node

Implements Node.

◆ InheritScale()

virtual bool InheritScale ( ) const
overridevirtual

Determine if this visual inherits scale from this parent.

Returns
True if this visual inherits scale from this parent

Implements Node.

◆ Init()

◆ Load()

virtual void Load ( )
overrideprotectedvirtual

Reimplemented from BaseObject.

Reimplemented in BaseCamera< Ogre2Sensor >.

◆ LocalScale()

virtual math::Vector3d LocalScale ( ) const
overridevirtual

Get the local scale.

Returns
The local scale

Implements Node.

◆ Node()

virtual Ogre::SceneNode* Node ( ) const
virtual

Get a pointer to the underlying scene node.

Returns
Ogre scene node pointer

◆ Parent()

virtual NodePtr Parent ( ) const
overridevirtual

Get the parent Node.

Returns
the parent Node

Implements Node.

◆ RawLocalPose()

virtual math::Pose3d RawLocalPose ( ) const
overrideprotectedvirtual

◆ RawLocalPosition()

virtual math::Vector3d RawLocalPosition ( ) const
protectedvirtual

Get the raw local position of the node.

Returns
Local position

◆ RawLocalRotation()

virtual math::Quaterniond RawLocalRotation ( ) const
protectedvirtual

Get the raw local rotation of the node.

Returns
Local rotation

◆ SetInheritScale()

virtual void SetInheritScale ( bool  _inherit)
overridevirtual

Specify if this visual inherits scale from its parent.

Parameters
[in]_inheritTrue if this visual inherits scale from its parent

Implements Node.

◆ SetLocalScaleImpl()

virtual void SetLocalScaleImpl ( const math::Vector3d _scale)
overrideprotectedvirtual

Implementation of the SetLocalScale function.

Parameters
[in]_scaleScale to set the visual to

Implements BaseNode< Ogre2Object >.

◆ SetParent()

virtual void SetParent ( Ogre2NodePtr  _parent)
protectedvirtual

Set the parent node.

Parameters
[in]_parentThe parent ogre node

◆ SetRawLocalPose()

virtual void SetRawLocalPose ( const math::Pose3d _Pose3d)
overrideprotectedvirtual

◆ SetRawLocalPosition()

virtual void SetRawLocalPosition ( const math::Vector3d _position)
protectedvirtual

Set the raw local position of the node.

Parameters
[in]_positionLocal position to set the node to

◆ SetRawLocalRotation()

virtual void SetRawLocalRotation ( const math::Quaterniond _rotation)
protectedvirtual

Set the raw local rotation of the node.

Parameters
[in]_rotationLocal rotation to set the node to

Member Data Documentation

◆ children

Ogre2NodeStorePtr children
protected

A list of child nodes.

◆ ogreNode

Ogre::SceneNode* ogreNode = nullptr
protected

The underlying ogre scene node.

◆ parent

Ogre2NodePtr parent
protected

Pointer to the parent ogre node.


The documentation for this class was generated from the following file: