agxRender::Renderable Class Reference

Inherit from this class and implement the render() method to make it it self during debug rendering. More...

#include <Renderable.h>

Inheritance diagram for agxRender::Renderable:

Public Member Functions
	Renderable ()
bool	getEnable () const
bool	isEnabled () const
virtual void	render (agxRender::RenderManager *mgr)=0
	Pure virtual method that should implemented to render a derived class during debug rendering.
void	setEnable (bool enable)
	Enable/disable this Renderable.
Public Member Functions inherited from agx::Referenced
	Referenced ()
	Default constructor.
	Referenced (const Referenced &)
template<typename T >
T *	as ()
	Subclass casting.
template<typename T >
const T *	as () const
template<typename T >
T *	asSafe ()
	Safe subclass casting, return nullptr if template type does not match.
template<typename T >
const T *	asSafe () const
int	getReferenceCount () const
template<typename T >
bool	is () const
	Subclass test.
Referenced &	operator= (const Referenced &)
	Assignment operator. Will increment the number of references to the referenced object.
void	reference (void *ptr=nullptr) const
	Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
void	unreference (void *ptr=nullptr) const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.
void	unreference_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is referencing it.

Protected Member Functions
virtual	~Renderable ()
	Destructor.
virtual void	addNotification ()
	Called when this Renderable is added to a RenderManager.
agxSDK::Simulation *	getSimulation ()
const agxSDK::Simulation *	getSimulation () const
virtual void	removeNotification ()
	Called when this Renderable is removed from a RenderManager.
void	setSimulation (agxSDK::Simulation *simulation)
	Set the associated simulation.
Protected Member Functions inherited from agx::Referenced
virtual	~Referenced ()
	Destructor.
void	allocateObserverVector () const
void	deleteUsingDeleteHandler () const

Additional Inherited Members
Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool	ValidateCast (const Referenced *object)
Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler *	getDeleteHandler ()
static void	setDeleteHandler (DeleteHandler *handler)
	Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
Protected Attributes inherited from agx::Referenced
Mutex	m_mutex
ObserverContainer	m_observers
AtomicValue	m_refCount

Detailed Description

Inherit from this class and implement the render() method to make it it self during debug rendering.

Definition at line 37 of file Renderable.h.

Constructor & Destructor Documentation

Renderable()

agxRender::Renderable::Renderable ( )

inline

Definition at line 40 of file Renderable.h.

~Renderable()

virtual agxRender::Renderable::~Renderable ( )

protectedvirtual

Destructor.

Member Function Documentation

addNotification()

virtual void agxRender::Renderable::addNotification ( )

inlineprotectedvirtual

Called when this Renderable is added to a RenderManager.

Definition at line 77 of file Renderable.h.

getEnable()

bool agxRender::Renderable::getEnable

(

)

const

Returns

true if this debug Renderable is enabled - otherwise false

getSimulation() [1/2]

agxSDK::Simulation * agxRender::Renderable::getSimulation ( )

protected

Returns

a pointer to the associated simulation

getSimulation() [2/2]

const agxSDK::Simulation * agxRender::Renderable::getSimulation ( ) const

protected

Returns

a pointer to the associated simulation

isEnabled()

bool agxRender::Renderable::isEnabled ( ) const

inline

Returns

true if this debug Renderable is enabled - otherwise false

Definition at line 53 of file Renderable.h.

removeNotification()

virtual void agxRender::Renderable::removeNotification ( )

inlineprotectedvirtual

Called when this Renderable is removed from a RenderManager.

Definition at line 80 of file Renderable.h.

render()

virtual void agxRender::Renderable::render ( agxRender::RenderManager *  mgr )

pure virtual

Pure virtual method that should implemented to render a derived class during debug rendering.

setEnable()

void agxRender::Renderable::setEnable

(

bool

enable

)

Enable/disable this Renderable.

If disabled, no calls to render will be made.

setSimulation()

void agxRender::Renderable::setSimulation ( agxSDK::Simulation *  simulation )

protected

Set the associated simulation.

---

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

• Renderable.h