Ignition Rendering

API Reference

5.1.0

Ogre2 implementation of a wire box geometry. More...

#include <Ogre2WireBox.hh>

Public Member Functions

virtual ~Ogre2WireBox ()
 Destructor. More...
 
virtual void Init () override
 
virtual MaterialPtr Material () const override
 Get the material of this geometry. More...
 
virtual Ogre::MovableObject * OgreObject () const override
 Get the ogre object representing this geometry. 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 void SetMaterial (MaterialPtr _material, bool _unique) override
 Set the materials of this Geometry. More...
 
- Public Member Functions inherited from BaseWireBox< Ogre2Geometry >
virtual ~BaseWireBox ()
 Destructor. More...
 
virtual ignition::math::AxisAlignedBox Box () const
 Get the wireframe box. More...
 
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 void SetBox (const ignition::math::AxisAlignedBox &_box)
 Set the axis aligned box. More...
 
- Public Member Functions inherited from WireBox
virtual ~WireBox ()
 Destructor. More...
 
- Public Member Functions inherited from Geometry
virtual ~Geometry ()
 Destructor. 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 Ogre2Geometry
virtual ~Ogre2Geometry ()
 Destructor. More...
 
virtual bool HasParent () const override
 Determine if this Geometry is attached to a Visual. More...
 
virtual VisualPtr Parent () const override
 Get the parent Visual. More...
 
- Public Member Functions inherited from BaseGeometry< Ogre2Object >
virtual ~BaseGeometry ()
 
virtual void RemoveParent () override
 Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done. More...
 
virtual void SetMaterial (const std::string &_material, bool _unique=true) override
 Set the materials of this Geometry. The specified material will be retrieved from the parent Scene. If no material is registered by the given name, no work will be done. 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

 Ogre2WireBox ()
 Constructor. More...
 
virtual void SetMaterialImpl (Ogre2MaterialPtr _material)
 Set material to wire box geometry. More...
 
- Protected Member Functions inherited from BaseWireBox< Ogre2Geometry >
 BaseWireBox ()
 Constructor. More...
 
- Protected Member Functions inherited from WireBox
 WireBox ()
 Constructor. More...
 
- Protected Member Functions inherited from Ogre2Geometry
 Ogre2Geometry ()
 Constructor. More...
 
virtual void SetParent (Ogre2VisualPtr _parent)
 Set the parent of this ogre geometry. More...
 
- Protected Member Functions inherited from BaseGeometry< Ogre2Object >
 BaseGeometry ()
 
- Protected Member Functions inherited from Ogre2Object
 Ogre2Object ()
 Constructor. More...
 
- Protected Member Functions inherited from BaseObject
 BaseObject ()
 
virtual void Load ()
 

Additional Inherited Members

- Protected Attributes inherited from BaseWireBox< Ogre2Geometry >
ignition::math::AxisAlignedBox box
 
bool wireBoxDirty
 Flag to indicate WireBox properties have changed. More...
 
- Protected Attributes inherited from Ogre2Geometry
Ogre2VisualPtr parent
 Parent visual. More...
 
- 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 implementation of a wire box geometry.

Constructor & Destructor Documentation

◆ Ogre2WireBox()

Ogre2WireBox ( )
protected

Constructor.

◆ ~Ogre2WireBox()

virtual ~Ogre2WireBox ( )
virtual

Destructor.

Member Function Documentation

◆ Init()

virtual void Init ( )
overridevirtual

Reimplemented from BaseObject.

◆ Material()

virtual MaterialPtr Material ( ) const
overridevirtual

Get the material of this geometry.

Returns
Material used by this geometry

Implements Geometry.

◆ OgreObject()

virtual Ogre::MovableObject* OgreObject ( ) const
overridevirtual

Get the ogre object representing this geometry.

Returns
Pointer to an ogre movable object

Implements Ogre2Geometry.

◆ PreRender()

virtual void PreRender ( )
overridevirtual

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.

Reimplemented from BaseWireBox< Ogre2Geometry >.

◆ SetMaterial()

virtual void SetMaterial ( MaterialPtr  _material,
bool  _unique 
)
overridevirtual

Set the materials of this Geometry.

Parameters
[in]_materialNew Material to be assigned
[in]_uniqueTrue if the given material should be cloned

Implements Geometry.

◆ SetMaterialImpl()

virtual void SetMaterialImpl ( Ogre2MaterialPtr  _material)
protectedvirtual

Set material to wire box geometry.

Parameters
[in]_materialOgre material.

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