Ignition Rendering

API Reference

5.0.0
Visual Class Referenceabstract

Represents a visual node in a scene graph. A Visual is the only node that can have Geometry and other Visual children. More...

#include <ignition/rendering/Visual.hh>

Public Member Functions

virtual ~Visual ()
 Destructor. More...
 
virtual void AddGeometry (GeometryPtr _geometry)=0
 Add the given geometry to this visual. If the given node is already attached, no work will be done. More...
 
virtual void AddVisibilityFlags (uint32_t _flags)=0
 Add visibility flags. More...
 
virtual ignition::math::AxisAlignedBox BoundingBox () const =0
 Get the bounding box in world frame coordinates. More...
 
virtual GeometryPtr GeometryByIndex (unsigned int _index) const =0
 Get geometry at given index. If no geometry exists at given index, NULL will be returned. More...
 
virtual unsigned int GeometryCount () const =0
 Get the number of geometries attached to this visual. More...
 
virtual bool HasGeometry (ConstGeometryPtr _geometry) const =0
 Determine if given geometry is attached to this visual. More...
 
virtual ignition::math::AxisAlignedBox LocalBoundingBox () const =0
 Get the local bounding box of the visual. More...
 
virtual MaterialPtr Material ()=0
 Get the material assigned to attached visuals and geometries. More...
 
virtual void RemoveGeometries ()=0
 Remove all attached geometries from this visual. More...
 
virtual GeometryPtr RemoveGeometry (GeometryPtr _geometry)=0
 Remove the given geometry from this visual. If the given node is not a child of this visual, no work will be done. More...
 
virtual GeometryPtr RemoveGeometryByIndex (unsigned int _index)=0
 Remove the geometry at the given index from this visual. If the specified node is not attached this visual, no work will be done. More...
 
virtual void RemoveVisibilityFlags (uint32_t _flags)=0
 Remove visibility flags. More...
 
virtual void SetChildMaterial (MaterialPtr _material, bool unique=true)=0
 Set the material for all attached visuals only. More...
 
virtual void SetGeometryMaterial (MaterialPtr _material, bool unique=true)=0
 Set the material for all attached geometries only. More...
 
virtual void SetMaterial (const std::string &_name, bool unique=true)=0
 Set the material for all attached visuals and geometries. The specified material will be retrieved from Scene::Material using the given material name. If no material is registered with the given name, no work will be done. More...
 
virtual void SetMaterial (MaterialPtr _material, bool unique=true)=0
 Set the material for all attached visuals and geometries. More...
 
virtual void SetUserData (const std::string &_key, Variant _value)=0
 Store any custom data associated with this visual. More...
 
virtual void SetVisibilityFlags (uint32_t _flags)=0
 Set visibility flags. More...
 
virtual void SetVisible (bool _visible)=0
 Specify if this visual is visible. More...
 
virtual Variant UserData (const std::string &_key) const =0
 Get custom data stored in this visual. More...
 
virtual uint32_t VisibilityFlags () const =0
 Get visibility flags. More...
 
- Public Member Functions inherited from Node
virtual ~Node ()
 Destructor. More...
 
virtual void AddChild (NodePtr _child)=0
 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 =0
 Get node with given ID. If no child exists with given ID, NULL will be returned. More...
 
virtual NodePtr ChildByIndex (unsigned int _index) const =0
 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 =0
 Get node with given name. If no child exists with given name, NULL will be returned. More...
 
virtual unsigned int ChildCount () const =0
 Get number of child nodes. More...
 
virtual bool HasChild (ConstNodePtr _child) const =0
 Determine if given node is an attached child. More...
 
virtual bool HasChildId (unsigned int _id) const =0
 Determine if node with given ID is an attached child. More...
 
virtual bool HasChildName (const std::string &_name) const =0
 Determine if node with given name is an attached child. More...
 
virtual bool HasParent () const =0
 Determine if this Node is attached to another Node. More...
 
virtual bool InheritScale () const =0
 Determine if this visual inherits scale from this parent. 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 LocalScale () const =0
 Get the local scale. More...
 
virtual math::Vector3d Origin () const =0
 Get position of origin. More...
 
virtual NodePtr Parent () const =0
 Get the parent Node. More...
 
virtual NodePtr RemoveChild (NodePtr _child)=0
 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)=0
 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)=0
 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)=0
 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 ()=0
 Remove all child nodes from this node This detaches all the child nodes but does not destroy them. More...
 
virtual void RemoveParent ()=0
 Detach this Node from its parent. If this Node does not have a parent, no work will be done. More...
 
virtual void Scale (double _scale)=0
 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)=0
 Scale the current scale by the given scalars. More...
 
virtual void Scale (const math::Vector3d &_scale)=0
 Scale the current scale by the given scalars. More...
 
virtual void SetInheritScale (bool _inherit)=0
 Specify if this visual inherits scale from its parent. 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 SetLocalScale (double _scale)=0
 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)=0
 Set the local scale. More...
 
virtual void SetLocalScale (const math::Vector3d &_scale)=0
 Set the local scale. 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 void SetWorldScale (double _scale)=0
 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)=0
 Set the world scale. More...
 
virtual void SetWorldScale (const math::Vector3d &_scale)=0
 Set the world scale. 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...
 
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 ()
 Destructor. 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 PostRender ()=0
 Post process this object and any of its children after rendering. 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 visual node in a scene graph. A Visual is the only node that can have Geometry and other Visual children.

Constructor & Destructor Documentation

◆ ~Visual()

Member Function Documentation

◆ AddGeometry()

virtual void AddGeometry ( GeometryPtr  _geometry)
pure virtual

Add the given geometry to this visual. If the given node is already attached, no work will be done.

Parameters
[in]_geometryGeometry to be added

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ AddVisibilityFlags()

virtual void AddVisibilityFlags ( uint32_t  _flags)
pure virtual

Add visibility flags.

Parameters
[in]_visibilityflags

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ BoundingBox()

virtual ignition::math::AxisAlignedBox BoundingBox ( ) const
pure virtual

Get the bounding box in world frame coordinates.

Returns
The axis aligned bounding box

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, Ogre2Visual, and OgreVisual.

Referenced by Visual::~Visual().

◆ GeometryByIndex()

virtual GeometryPtr GeometryByIndex ( unsigned int  _index) const
pure virtual

Get geometry at given index. If no geometry exists at given index, NULL will be returned.

Parameters
[in]_indexIndex of the desired geometry
Returns
The specified geometry

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ GeometryCount()

virtual unsigned int GeometryCount ( ) const
pure virtual

Get the number of geometries attached to this visual.

Returns
The number of geometries attached to this visual

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ HasGeometry()

virtual bool HasGeometry ( ConstGeometryPtr  _geometry) const
pure virtual

Determine if given geometry is attached to this visual.

Parameters
[in]_geometryGeometry in question
Returns
True if given node is attached to this visual

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ LocalBoundingBox()

virtual ignition::math::AxisAlignedBox LocalBoundingBox ( ) const
pure virtual

Get the local bounding box of the visual.

Returns
The local bounding box

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, Ogre2Visual, and OgreVisual.

Referenced by Visual::~Visual().

◆ Material()

virtual MaterialPtr Material ( )
pure virtual

Get the material assigned to attached visuals and geometries.

Returns
the Pointer to the material assigned to this visual. If the material is cloned at the time it is set to this visual, the cloned material will be returned.

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ RemoveGeometries()

virtual void RemoveGeometries ( )
pure virtual

Remove all attached geometries from this visual.

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ RemoveGeometry()

virtual GeometryPtr RemoveGeometry ( GeometryPtr  _geometry)
pure virtual

Remove the given geometry from this visual. If the given node is not a child of this visual, no work will be done.

Parameters
[in]_geometryGeometry to be removed
Returns
The removed geometry

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ RemoveGeometryByIndex()

virtual GeometryPtr RemoveGeometryByIndex ( unsigned int  _index)
pure virtual

Remove the geometry at the given index from this visual. If the specified node is not attached this visual, no work will be done.

Parameters
[in]_indexIndex of the geometry to be removed
Returns
The removed geometry

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ RemoveVisibilityFlags()

virtual void RemoveVisibilityFlags ( uint32_t  _flags)
pure virtual

Remove visibility flags.

Parameters
[in]_visibilityflags

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ SetChildMaterial()

virtual void SetChildMaterial ( MaterialPtr  _material,
bool  unique = true 
)
pure virtual

Set the material for all attached visuals only.

Parameters
[in]_nameName of the material to be assigned
[in]_uniqueTrue if the specified material should be cloned

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ SetGeometryMaterial()

virtual void SetGeometryMaterial ( MaterialPtr  _material,
bool  unique = true 
)
pure virtual

Set the material for all attached geometries only.

Parameters
[in]_nameName of the material to be assigned
[in]_uniqueTrue if the specified material should be cloned

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ SetMaterial() [1/2]

virtual void SetMaterial ( const std::string _name,
bool  unique = true 
)
pure virtual

Set the material for all attached visuals and geometries. The specified material will be retrieved from Scene::Material using the given material name. If no material is registered with the given name, no work will be done.

Parameters
[in]_nameName of the material to be assigned
[in]_uniqueTrue if the specified material should be cloned

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ SetMaterial() [2/2]

virtual void SetMaterial ( MaterialPtr  _material,
bool  unique = true 
)
pure virtual

Set the material for all attached visuals and geometries.

Parameters
[in]_nameName of the material to be assigned
[in]_uniqueTrue if the specified material should be cloned

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, OgreLightVisual, and Ogre2LightVisual.

◆ SetUserData()

virtual void SetUserData ( const std::string _key,
Variant  _value 
)
pure virtual

Store any custom data associated with this visual.

Parameters
[in]_keyUnique key
[in]_valueValue in any type

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ SetVisibilityFlags()

virtual void SetVisibilityFlags ( uint32_t  _flags)
pure virtual

Set visibility flags.

Parameters
[in]_flagsVisibility flags

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, Ogre2Visual, and OgreVisual.

Referenced by Visual::~Visual().

◆ SetVisible()

virtual void SetVisible ( bool  _visible)
pure virtual

Specify if this visual is visible.

Parameters
[in]_visibleTrue if this visual should be made visible

Implemented in OgreLidarVisual, BaseVisual< T >, BaseVisual< Ogre2Node >, BaseVisual< OgreNode >, Ogre2LidarVisual, Ogre2Visual, and OgreVisual.

Referenced by Visual::~Visual().

◆ UserData()

virtual Variant UserData ( const std::string _key) const
pure virtual

Get custom data stored in this visual.

Parameters
[in]_keyUnique key
[in]_valueValue in any type

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().

◆ VisibilityFlags()

virtual uint32_t VisibilityFlags ( ) const
pure virtual

Get visibility flags.

Returns
visibility flags

Implemented in BaseVisual< T >, BaseVisual< Ogre2Node >, and BaseVisual< OgreNode >.

Referenced by Visual::~Visual().


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