BaseWireBox< T > Class Template Reference

Base implementation of a wireframe box. More...

#include <BaseWireBox.hh>

Public Member Functions
virtual	~BaseWireBox ()
	Destructor.
virtual gz::math::AxisAlignedBox	Box () const
	Get the wireframe box.
virtual void	Destroy ()
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
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.
virtual void	SetBox (const gz::math::AxisAlignedBox &_box)
	Set the axis aligned box.
Public Member Functions inherited from WireBox
virtual	~WireBox ()
	Destructor.
Public Member Functions inherited from Geometry
virtual	~Geometry ()
	Destructor.
virtual GeometryPtr	Clone () const =0
	Clone the geometry.
virtual bool	HasParent () const =0
	Determine if this Geometry is attached to a Visual.
virtual MaterialPtr	Material () const =0
	Get the material of this geometry.
virtual VisualPtr	Parent () const =0
	Get the parent Visual.
virtual void	RemoveParent ()=0
	Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done.
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.
virtual void	SetMaterial (MaterialPtr _material, bool _unique=true)=0
	Set the materials of this Geometry.
Public Member Functions inherited from Object
virtual	~Object ()
	Destructor.
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.
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.
virtual void	PostRender ()=0
	Post process this object and any of its children after rendering.
virtual ScenePtr	Scene () const =0
	Get the Scene that created this object.

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

Protected Attributes
gz::math::AxisAlignedBox	box
bool	wireBoxDirty = false
	Flag to indicate WireBox properties have changed.

Detailed Description

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

Base implementation of a wireframe box.

Constructor & Destructor Documentation

BaseWireBox()

template<class T >

BaseWireBox ( )

protected

Constructor.

~BaseWireBox()

template<class T >

~BaseWireBox ( )

virtual

Destructor.

Member Function Documentation

Box()

template<class T >

gz::math::AxisAlignedBox Box ( ) const

virtual

Get the wireframe box.

Returns

The wireframe box.

Implements WireBox.

Destroy()

template<class T >

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()

template<class T >

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, and Ogre2WireBox.

SetBox()

template<class T >

void SetBox ( const gz::math::AxisAlignedBox &  _box )

virtual

Set the axis aligned box.

Parameters

[in]

_box

The axis aligned box

Implements WireBox.

Member Data Documentation

box

template<class T >

gz::math::AxisAlignedBox box

protected

wireBoxDirty

template<class T >

bool wireBoxDirty = false

protected

Flag to indicate WireBox properties have changed.

---

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

• BaseWireBox.hh