Ignition Rendering

API Reference

0.1.0

#include <OgreNode.hh>

Public Member Functions

virtual ~OgreNode ()
 
virtual void Destroy ()
 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
 Determine if this Geometry is attached to a Visual. More...
 
virtual Ogre::SceneNodeNode () const
 
virtual VisualPtr Parent () const
 Get the parent Visual. More...
 
- Public Member Functions inherited from BaseNode< OgreObject >
virtual ~BaseNode ()
 
virtual math::Pose3d LocalPose () const
 Get the local pose. More...
 
virtual math::Vector3d LocalPosition () const
 Get the local position. More...
 
virtual math::Quaterniond LocalRotation () const
 Get the local rotation. More...
 
virtual math::Vector3d Origin () const
 Get position of origin. More...
 
virtual void RemoveParent ()
 Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done. More...
 
virtual void SetLocalPose (const math::Pose3d &_pose)
 Set the local pose. More...
 
virtual void SetLocalPosition (double _x, double _y, double _z)
 Set the local position. More...
 
virtual void SetLocalPosition (const math::Vector3d &_position)
 Set the local position. More...
 
virtual void SetLocalRotation (double _r, double _p, double _y)
 Set the local rotation. More...
 
virtual void SetLocalRotation (double _w, double _x, double _y, double _z)
 Set the local rotation. More...
 
virtual void SetLocalRotation (const math::Quaterniond &_rotation)
 Set the local rotation. More...
 
virtual void SetOrigin (double _x, double _y, double _z)
 Set position of origin. The position should be relative to the original origin of the geometry. More...
 
virtual void SetOrigin (const math::Vector3d &_origin)
 Set position of origin. The position should be relative to the original origin of the geometry. More...
 
virtual void SetWorldPose (const math::Pose3d &_pose)
 Set the world pose. More...
 
virtual void SetWorldPosition (double _x, double _y, double _z)
 Set the world position. More...
 
virtual void SetWorldPosition (const math::Vector3d &_position)
 Set the world position. More...
 
virtual void SetWorldRotation (double _r, double _p, double _y)
 Set the world rotation. More...
 
virtual void SetWorldRotation (double _w, double _x, double _y, double _z)
 Set the world rotation. More...
 
virtual void SetWorldRotation (const math::Quaterniond &_rotation)
 Set the world rotation. More...
 
virtual math::Pose3d WorldPose () const
 Get the world pose. More...
 
virtual math::Vector3d WorldPosition () const
 Get the world position. More...
 
virtual math::Quaterniond WorldRotation () const
 Get the world rotation. More...
 
virtual math::Pose3d WorldToLocal (const math::Pose3d &_pose) const
 Convert given world pose to local pose. More...
 
- Public Member Functions inherited from Node
virtual ~Node ()
 Deconstructor. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Deconstructor. More...
 
- Public Member Functions inherited from OgreObject
virtual ~OgreObject ()
 
virtual ScenePtr Scene () const
 Get the Scene that created this object. More...
 
- Public Member Functions inherited from BaseObject
virtual ~BaseObject ()
 
virtual unsigned int Id () const
 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
 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 PreRender ()
 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...
 
- Public Member Functions inherited from enable_shared_from_this< BaseObject >
enable_shared_from_this (T... args)
 
~enable_shared_from_this (T... args)
 
operator= (T... args)
 
shared_from_this (T... args)
 

Protected Member Functions

 OgreNode ()
 
virtual void Init ()
 
virtual void Load ()
 
virtual math::Pose3d RawLocalPose () const
 
virtual math::Vector3d RawLocalPosition () const
 
virtual math::Quaterniond RawLocalRotation () const
 
virtual void SetParent (OgreVisualPtr _parent)
 
virtual void SetRawLocalPose (const math::Pose3d &_Pose3d)
 
virtual void SetRawLocalPosition (const math::Vector3d &_position)
 
virtual void SetRawLocalRotation (const math::Quaterniond &_rotation)
 
- Protected Member Functions inherited from BaseNode< OgreObject >
 BaseNode ()
 
- Protected Member Functions inherited from OgreObject
 OgreObject ()
 
- Protected Member Functions inherited from BaseObject
 BaseObject ()
 

Protected Attributes

Ogre::SceneNodeogreNode
 
OgreVisualPtr parent
 
- Protected Attributes inherited from BaseNode< OgreObject >
math::Vector3d origin
 
- Protected Attributes inherited from OgreObject
OgreScenePtr scene
 
- Protected Attributes inherited from BaseObject
unsigned int id
 
std::string name
 

Constructor & Destructor Documentation

◆ OgreNode()

OgreNode ( )
protected

◆ ~OgreNode()

virtual ~OgreNode ( )
virtual

Member Function Documentation

◆ Destroy()

virtual void Destroy ( )
virtual

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

Reimplemented from BaseNode< OgreObject >.

Reimplemented in BaseVisual< OgreNode >, and OgreLight.

◆ HasParent()

virtual bool HasParent ( ) const
virtual

Determine if this Geometry is attached to a Visual.

Returns
True if this Geometry has a parent Visual

Implements Node.

◆ Init()

virtual void Init ( )
protectedvirtual

◆ Load()

virtual void Load ( )
protectedvirtual

Reimplemented from BaseObject.

Reimplemented in BaseCamera< OgreSensor >.

◆ Node()

virtual Ogre::SceneNode* Node ( ) const
virtual

◆ Parent()

virtual VisualPtr Parent ( ) const
virtual

Get the parent Visual.

Returns
the parent Visual

Implements BaseNode< OgreObject >.

◆ RawLocalPose()

virtual math::Pose3d RawLocalPose ( ) const
protectedvirtual

◆ RawLocalPosition()

virtual math::Vector3d RawLocalPosition ( ) const
protectedvirtual

◆ RawLocalRotation()

virtual math::Quaterniond RawLocalRotation ( ) const
protectedvirtual

◆ SetParent()

virtual void SetParent ( OgreVisualPtr  _parent)
protectedvirtual

◆ SetRawLocalPose()

virtual void SetRawLocalPose ( const math::Pose3d &  _Pose3d)
protectedvirtual

◆ SetRawLocalPosition()

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

◆ SetRawLocalRotation()

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

Member Data Documentation

◆ ogreNode

Ogre::SceneNode* ogreNode
protected

◆ parent

OgreVisualPtr parent
protected

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