Ignition Rendering

API Reference

6.3.1

Base implementation of a wireframe box. More...

#include <BaseWireBox.hh>

Public Member Functions

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 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...
 
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...
 
virtual GeometryPtr Clone () const =0
 Clone the geometry. More...
 
virtual bool HasParent () const =0
 Determine if this Geometry is attached to a Visual. More...
 
virtual MaterialPtr Material () const =0
 Get the material of this geometry. 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 SetMaterial (const std::string &_name, bool _unique=true)=0
 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...
 
virtual void SetMaterial (MaterialPtr _material, bool _unique=true)=0
 Set the materials of this Geometry. 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...
 

Protected Member Functions

 BaseWireBox ()
 Constructor. More...
 
- Protected Member Functions inherited from WireBox
 WireBox ()
 Constructor. More...
 

Protected Attributes

ignition::math::AxisAlignedBox box
 
bool wireBoxDirty = false
 Flag to indicate WireBox properties have changed. More...
 

Detailed Description

template<class T>
class ignition::rendering::BaseWireBox< T >

Base implementation of a wireframe box.

Constructor & Destructor Documentation

◆ BaseWireBox()

BaseWireBox ( )
protected

Constructor.

◆ ~BaseWireBox()

~BaseWireBox ( )
virtual

Destructor.

Member Function Documentation

◆ Box()

ignition::math::AxisAlignedBox Box ( ) const
virtual

Get the wireframe box.

Returns
The wireframe box.

Implements WireBox.

◆ 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.

◆ PreRender()

void PreRender ( )
virtual

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.

Implements Object.

Reimplemented in OgreWireBox.

◆ SetBox()

void SetBox ( const ignition::math::AxisAlignedBox _box)
virtual

Set the axis aligned box.

Parameters
[in]_boxThe axis aligned box

Implements WireBox.

Member Data Documentation

◆ box

◆ wireBoxDirty

bool wireBoxDirty = false
protected

Flag to indicate WireBox properties have changed.

Referenced by BaseWireBox< OgreGeometry >::SetBox().


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