Represents a single posable node in the scene graph. More...

#include <ignition/rendering/Node.hh>

Public Member Functions
virtual	~Node ()
	Deconstructor. More...

virtual bool	HasParent () const =0
	Determine if this Geometry is attached to a Visual. 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 VisualPtr	Parent () const =0
	Get the parent Visual. More...

virtual void	RemoveParent ()=0
	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)=0
	Set the local pose. More...

virtual void	SetLocalPosition (double _x, double _y, double _z)=0
	Set the local position. More...

virtual void	SetLocalPosition (const math::Vector3d &_position)=0
	Set the local position. More...

virtual void	SetLocalRotation (double _r, double _p, double _y)=0
	Set the local rotation. More...

virtual void	SetLocalRotation (double _w, double _x, double _y, double _z)=0
	Set the local rotation. More...

virtual void	SetLocalRotation (const math::Quaterniond &_rotation)=0
	Set the local rotation. More...

virtual void	SetOrigin (double _x, double _y, double _z)=0
	Set position of origin. The position should be relative to the original origin of the geometry. More...

virtual void	SetOrigin (const math::Vector3d &_origin)=0
	Set position of origin. The position should be relative to the original origin of the geometry. More...

virtual void	SetWorldPose (const math::Pose3d &_pose)=0
	Set the world pose. More...

virtual void	SetWorldPosition (double _x, double _y, double _z)=0
	Set the world position. More...

virtual void	SetWorldPosition (const math::Vector3d &_position)=0
	Set the world position. More...

virtual void	SetWorldRotation (double _r, double _p, double _y)=0
	Set the world rotation. More...

virtual void	SetWorldRotation (double _w, double _x, double _y, double _z)=0
	Set the world rotation. More...

virtual void	SetWorldRotation (const math::Quaterniond &_rotation)=0
	Set the world rotation. 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::Pose3d	WorldToLocal (const math::Pose3d &_pose) const =0
	Convert given world pose to local pose. More...

Public Member Functions inherited from Object
virtual	~Object ()
	Deconstructor. More...

virtual void	Destroy ()=0
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. 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	PreRender ()=0
	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 ScenePtr	Scene () const =0
	Get the Scene that created this object. More...

Detailed Description

Represents a single posable node in the scene graph.

Constructor & Destructor Documentation

◆ ~Node()

virtual ~Node ( )

inlinevirtual

Deconstructor.

References Node::HasParent(), Node::LocalPose(), Node::LocalPosition(), Node::LocalRotation(), Node::Origin(), Node::Parent(), Node::RemoveParent(), Node::SetLocalPose(), Node::SetLocalPosition(), Node::SetLocalRotation(), Node::SetOrigin(), Node::SetWorldPose(), Node::SetWorldPosition(), Node::SetWorldRotation(), Node::WorldPose(), Node::WorldPosition(), Node::WorldRotation(), and Node::WorldToLocal().

Member Function Documentation

◆ HasParent()

virtual bool HasParent ( ) const

pure virtual

Determine if this Geometry is attached to a Visual.

Returns: True if this Geometry has a parent Visual

Implemented in OgreNode.

Referenced by BaseVisual< OgreNode >::WorldScale(), and Node::~Node().

◆ LocalPose()

virtual math::Pose3d LocalPose ( ) const

pure virtual

Get the local pose.

Returns: The local pose

Implemented in BaseVisual< T >, BaseVisual< OgreNode >, BaseNode< T >, and BaseNode< OgreObject >.

Referenced by Node::~Node().

◆ LocalPosition()

virtual math::Vector3d LocalPosition ( ) const

pure virtual

Get the local position.

Returns: The local position

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by Node::~Node().

◆ LocalRotation()

virtual math::Quaterniond LocalRotation ( ) const

pure virtual

Get the local rotation.

Returns: The local rotation

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by Node::~Node().

◆ Origin()

virtual math::Vector3d Origin ( ) const

pure virtual

Get position of origin.

Returns: The position of the origin

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by Node::~Node().

◆ Parent()

virtual VisualPtr Parent ( ) const

pure virtual

Get the parent Visual.

Returns: the parent Visual

Implemented in OgreNode, BaseNode< T >, and BaseNode< OgreObject >.

Referenced by BaseVisual< OgreNode >::WorldScale(), and Node::~Node().

◆ RemoveParent()

virtual void RemoveParent ( )

pure virtual

Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done.

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by Node::~Node().

◆ SetLocalPose()

virtual void SetLocalPose ( const math::Pose3d & _pose )

pure virtual

Set the local pose.

Parameters

[in] _pose New local pose

Implemented in BaseVisual< T >, BaseVisual< OgreNode >, BaseNode< T >, and BaseNode< OgreObject >.

Referenced by Node::~Node().

◆ SetLocalPosition() [1/2]

virtual void SetLocalPosition	(	double	_x,
		double	_y,
		double	_z
	)

pure virtual

Set the local position.

Parameters

[in]	_x	X-coordinate
[in]	_y	Y-coordinate
[in]	_z	Z-coordinate

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by Node::~Node().

◆ SetLocalPosition() [2/2]

virtual void SetLocalPosition ( const math::Vector3d & _position )

pure virtual

Set the local position.

Parameters

[in] _position New local position

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

◆ SetLocalRotation() [1/3]

virtual void SetLocalRotation	(	double	_r,
		double	_p,
		double	_y
	)

pure virtual

Set the local rotation.

Parameters

[in]	_r	roll
[in]	_p	pitch
[in]	_y	yaw

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by Node::~Node().

◆ SetLocalRotation() [2/3]

virtual void SetLocalRotation	(	double	_w,
		double	_x,
		double	_y,
		double	_z
	)

pure virtual

Set the local rotation.

Parameters

[in]	_w	W-coordinate
[in]	_x	X-coordinate
[in]	_y	Y-coordinate
[in]	_z	Z-coordinate

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

◆ SetLocalRotation() [3/3]

virtual void SetLocalRotation ( const math::Quaterniond & _rotation )

pure virtual

Set the local rotation.

Parameters

[in] _rotation New local rotation

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

◆ SetOrigin() [1/2]

virtual void SetOrigin	(	double	_x,
		double	_y,
		double	_z
	)

pure virtual

Set position of origin. The position should be relative to the original origin of the geometry.

Parameters

[in]	_x	X-coordinate
[in]	_y	Y-coordinate
[in]	_z	Z-coordinate

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by BaseArrowVisual< OgreVisual >::Init(), and Node::~Node().

◆ SetOrigin() [2/2]

virtual void SetOrigin ( const math::Vector3d & _origin )

pure virtual

Set position of origin. The position should be relative to the original origin of the geometry.

Parameters

[in] _origin New origin position

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

◆ SetWorldPose()

virtual void SetWorldPose ( const math::Pose3d & _pose )

pure virtual

Set the world pose.

Parameters

[in] _pose New world pose

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by Node::~Node().

◆ SetWorldPosition() [1/2]

virtual void SetWorldPosition	(	double	_x,
		double	_y,
		double	_z
	)

pure virtual

Set the world position.

Parameters

[in]	_x	X-coordinate
[in]	_y	Y-coordinate
[in]	_z	Z-coordinate

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by BaseCamera< OgreSensor >::PreRender(), and Node::~Node().

◆ SetWorldPosition() [2/2]

virtual void SetWorldPosition ( const math::Vector3d & _position )

pure virtual

Set the world position.

Parameters

[in] _position New world position

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

◆ SetWorldRotation() [1/3]

virtual void SetWorldRotation	(	double	_r,
		double	_p,
		double	_y
	)

pure virtual

Set the world rotation.

Parameters

[in]	_r	roll
[in]	_p	pitch
[in]	_y	yaw

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by BaseCamera< OgreSensor >::PreRender(), and Node::~Node().

◆ SetWorldRotation() [2/3]

virtual void SetWorldRotation	(	double	_w,
		double	_x,
		double	_y,
		double	_z
	)

pure virtual

Set the world rotation.

Parameters

[in]	_w	W-coordinate
[in]	_x	X-coordinate
[in]	_y	Y-coordinate
[in]	_z	Z-coordinate

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

◆ SetWorldRotation() [3/3]

virtual void SetWorldRotation ( const math::Quaterniond & _rotation )

pure virtual

Set the world rotation.

Parameters

[in] _rotation New world rotation

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

◆ WorldPose()

virtual math::Pose3d WorldPose ( ) const

pure virtual

Get the world pose.

Returns: The world pose

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by BaseCamera< OgreSensor >::ViewMatrix(), and Node::~Node().

◆ WorldPosition()

virtual math::Vector3d WorldPosition ( ) const

pure virtual

Get the world position.

Returns: The world position

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by BaseCamera< OgreSensor >::PreRender(), and Node::~Node().

◆ WorldRotation()

virtual math::Quaterniond WorldRotation ( ) const

pure virtual

Get the world rotation.

Returns: The world rotation

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by BaseCamera< OgreSensor >::PreRender(), and Node::~Node().

◆ WorldToLocal()

virtual math::Pose3d WorldToLocal ( const math::Pose3d & _pose ) const

pure virtual

Convert given world pose to local pose.

Parameters

[in] _pose World pose to be converted

Implemented in BaseNode< T >, and BaseNode< OgreObject >.

Referenced by Node::~Node().

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

Node.hh

Ignition Rendering

API Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~Node()

Member Function Documentation

◆ HasParent()

◆ LocalPose()

◆ LocalPosition()

◆ LocalRotation()

◆ Origin()

◆ Parent()

◆ RemoveParent()

◆ SetLocalPose()

◆ SetLocalPosition() [1/2]

◆ SetLocalPosition() [2/2]

◆ SetLocalRotation() [1/3]

◆ SetLocalRotation() [2/3]

◆ SetLocalRotation() [3/3]

◆ SetOrigin() [1/2]

◆ SetOrigin() [2/2]

◆ SetWorldPose()

◆ SetWorldPosition() [1/2]

◆ SetWorldPosition() [2/2]

◆ SetWorldRotation() [1/3]

◆ SetWorldRotation() [2/3]

◆ SetWorldRotation() [3/3]

◆ WorldPose()

◆ WorldPosition()

◆ WorldRotation()

◆ WorldToLocal()