#include <BaseNode.hh>

Public Member Functions
virtual	~BaseNode ()

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 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 VisualPtr	Parent () const =0
	Get the parent Visual. 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...

virtual bool	HasParent () const =0
	Determine if this Geometry is attached to a Visual. More...

Public Member Functions inherited from Object
virtual	~Object ()
	Deconstructor. 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...

Protected Member Functions
	BaseNode ()

virtual math::Pose3d	RawLocalPose () const =0

virtual void	SetRawLocalPose (const math::Pose3d &_pose)=0

Protected Attributes
math::Vector3d	origin

Constructor & Destructor Documentation

◆ BaseNode()

BaseNode ( )

protected

◆ ~BaseNode()

~BaseNode ( )

virtual

Member Function Documentation

◆ Destroy()

void Destroy ( )

virtual

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

Implements Object.

Reimplemented in BaseVisual< OgreNode >, OgreLight, and OgreNode.

◆ LocalPose()

math::Pose3d LocalPose ( ) const

virtual

Get the local pose.

Returns: The local pose

Implements Node.

Reimplemented in BaseVisual< OgreNode >.

Referenced by BaseNode< OgreObject >::LocalPosition(), BaseNode< OgreObject >::LocalRotation(), BaseNode< OgreObject >::SetLocalPosition(), BaseNode< OgreObject >::SetLocalRotation(), and BaseNode< OgreObject >::WorldPose().

◆ LocalPosition()

math::Vector3d LocalPosition ( ) const

virtual

Get the local position.

Returns: The local position

Implements Node.

◆ LocalRotation()

math::Quaterniond LocalRotation ( ) const

virtual

Get the local rotation.

Returns: The local rotation

Implements Node.

◆ Origin()

math::Vector3d Origin ( ) const

virtual

Get position of origin.

Returns: The position of the origin

Implements Node.

◆ Parent()

virtual VisualPtr Parent ( ) const

pure virtual

Get the parent Visual.

Returns: the parent Visual

Implements Node.

Implemented in OgreNode.

Referenced by BaseNode< OgreObject >::RemoveParent(), BaseNode< OgreObject >::WorldPose(), and BaseNode< OgreObject >::WorldToLocal().

◆ RawLocalPose()

virtual math::Pose3d RawLocalPose ( ) const

protectedpure virtual

Implemented in OgreNode.

Referenced by BaseNode< OgreObject >::LocalPose().

◆ RemoveParent()

void RemoveParent ( )

virtual

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

Implements Node.

Referenced by BaseNode< OgreObject >::Destroy().

◆ SetLocalPose()

void SetLocalPose ( const math::Pose3d & _pose )

virtual

Set the local pose.

Parameters

[in] _pose New local pose

Implements Node.

Reimplemented in BaseVisual< OgreNode >.

Referenced by BaseNode< OgreObject >::SetLocalPosition(), BaseNode< OgreObject >::SetLocalRotation(), and BaseNode< OgreObject >::SetWorldPose().

◆ SetLocalPosition() [1/2]

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

virtual

Set the local position.

Parameters

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

Implements Node.

Referenced by BaseNode< OgreObject >::SetLocalPosition().

◆ SetLocalPosition() [2/2]

void SetLocalPosition ( const math::Vector3d & _position )

virtual

Set the local position.

Parameters

[in] _position New local position

Implements Node.

◆ SetLocalRotation() [1/3]

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

virtual

Set the local rotation.

Parameters

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

Implements Node.

Referenced by BaseNode< OgreObject >::SetLocalRotation().

◆ SetLocalRotation() [2/3]

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

virtual

Set the local rotation.

Parameters

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

Implements Node.

◆ SetLocalRotation() [3/3]

void SetLocalRotation ( const math::Quaterniond & _rotation )

virtual

Set the local rotation.

Parameters

[in] _rotation New local rotation

Implements Node.

◆ SetOrigin() [1/2]

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

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

Implements Node.

Referenced by BaseNode< OgreObject >::SetOrigin().

◆ SetOrigin() [2/2]

void SetOrigin ( const math::Vector3d & _origin )

virtual

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

Parameters

[in] _origin New origin position

Implements Node.

◆ SetRawLocalPose()

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

protectedpure virtual

Implemented in OgreNode.

Referenced by BaseNode< OgreObject >::SetLocalPose().

◆ SetWorldPose()

void SetWorldPose ( const math::Pose3d & _pose )

virtual

Set the world pose.

Parameters

[in] _pose New world pose

Implements Node.

Referenced by BaseNode< OgreObject >::SetWorldPosition(), and BaseNode< OgreObject >::SetWorldRotation().

◆ SetWorldPosition() [1/2]

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

virtual

Set the world position.

Parameters

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

Implements Node.

Referenced by BaseNode< OgreObject >::SetWorldPosition().

◆ SetWorldPosition() [2/2]

void SetWorldPosition ( const math::Vector3d & _position )

virtual

Set the world position.

Parameters

[in] _position New world position

Implements Node.

◆ SetWorldRotation() [1/3]

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

virtual

Set the world rotation.

Parameters

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

Implements Node.

Referenced by BaseNode< OgreObject >::SetWorldRotation().

◆ SetWorldRotation() [2/3]

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

virtual

Set the world rotation.

Parameters

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

Implements Node.

◆ SetWorldRotation() [3/3]

void SetWorldRotation ( const math::Quaterniond & _rotation )

virtual

Set the world rotation.

Parameters

[in] _rotation New world rotation

Implements Node.

◆ WorldPose()

math::Pose3d WorldPose ( ) const

virtual

Get the world pose.

Returns: The world pose

Implements Node.

Referenced by BaseNode< OgreObject >::SetWorldPosition(), BaseNode< OgreObject >::SetWorldRotation(), BaseNode< OgreObject >::WorldPosition(), and BaseNode< OgreObject >::WorldRotation().

◆ WorldPosition()

math::Vector3d WorldPosition ( ) const

virtual

Get the world position.

Returns: The world position

Implements Node.

◆ WorldRotation()

math::Quaterniond WorldRotation ( ) const

virtual

Get the world rotation.

Returns: The world rotation

Implements Node.

◆ WorldToLocal()

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

virtual

Convert given world pose to local pose.

Parameters

[in] _pose World pose to be converted

Implements Node.

Referenced by BaseNode< OgreObject >::SetWorldPose().

Member Data Documentation

◆ origin

math::Vector3d origin

protected

Referenced by BaseNode< OgreObject >::LocalPose(), BaseNode< OgreObject >::Origin(), BaseNode< OgreObject >::SetLocalPose(), and BaseNode< OgreObject >::SetOrigin().

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

BaseNode.hh

Ignition Rendering

API Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ BaseNode()

◆ ~BaseNode()

Member Function Documentation

◆ Destroy()

◆ LocalPose()

◆ LocalPosition()

◆ LocalRotation()

◆ Origin()

◆ Parent()

◆ RawLocalPose()

◆ RemoveParent()

◆ SetLocalPose()

◆ SetLocalPosition() [1/2]

◆ SetLocalPosition() [2/2]

◆ SetLocalRotation() [1/3]

◆ SetLocalRotation() [2/3]

◆ SetLocalRotation() [3/3]

◆ SetOrigin() [1/2]

◆ SetOrigin() [2/2]

◆ SetRawLocalPose()

◆ SetWorldPose()

◆ SetWorldPosition() [1/2]

◆ SetWorldPosition() [2/2]

◆ SetWorldRotation() [1/3]

◆ SetWorldRotation() [2/3]

◆ SetWorldRotation() [3/3]

◆ WorldPose()

◆ WorldPosition()

◆ WorldRotation()

◆ WorldToLocal()

Member Data Documentation

◆ origin