Associates a Renderable object to an Effect and Transform. More...

#include <Actor.hpp>

Inheritance diagram for vl::Actor:

Public Member Functions
	Actor (Renderable renderable=NULL, Effect effect=NULL, Transform *transform=NULL, int block=0, int rank=0)
	Constructor. More...

virtual	~Actor ()
	Destructor. More...

void	setLod (int lod_index, Renderable *renderable)
	Sets the Renderable object representing the LOD level specifed by `lod_index`. More...

const Renderable *	lod (int lod_index) const
	Returns the Renderable object representing the LOD level specifed by `lod_index`. More...

Renderable *	lod (int lod_index)
	Returns the Renderable object representing the LOD level specifed by `lod_index`. More...

void	setLODs (Renderable lod0, Renderable lod1=NULL, Renderable lod2=NULL, Renderable lod3=NULL, Renderable lod4=NULL, Renderable lod5=NULL)
	Utility function to assign one or more Renderable[s] to one or more LOD levels. More...

void	setTransform (Transform *transform)
	Binds a Transform to an Actor. More...

Transform *	transform ()
	Returns the Transform bound tho an Actor. More...

const Transform *	transform () const
	Returns the Transform bound tho an Actor. More...

void	setEffect (Effect *effect)
	Binds an Effect to an Actor. More...

Effect *	effect ()
	Returns the Effect bound to an Actor. More...

const Effect *	effect () const
	Returns the Effect bound to an Actor. More...

const AABB &	boundingBox () const
	Returns the bounding box (`not` guaranteed to be up to date) that contains this Actor. More...

const Sphere &	boundingSphere () const
	Returns the bounding sphere (`not` guaranteed to be up to date) that contains this Actor. More...

const AABB &	boundingBoxSafe ()
	Returns the bounding box (`guaranteed` to be up to date) that contains this Actor. More...

const Sphere &	boundingSphereSafe ()
	Returns the bounding sphere (`guaranteed` to be up to date) that contains this Actor. More...

void	computeBounds ()
	Computes the bounding box and bounding sphere of an Actor if boundsDirty(). More...

bool	boundsDirty () const
	Returns whether the Actor's bounding box and sphere are up to date. More...

void	setRenderRank (int rank)
	Modifies the rendering rank of an Actor. More...

void	setRenderBlock (int block)
	Modifies the rendering block of an Actor. More...

int	renderRank () const
	Returns the rendering rank of an Actor. More...

int	renderBlock () const
	Returns the rendering block of an Actor. More...

void	setLODEvaluator (LODEvaluator *lod_evaluator)
	Installs the LODEvaluator used to compute the current LOD at rendering time. More...

LODEvaluator *	lodEvaluator ()
	Returns the installed LODEvaluator (if any) or NULL. More...

const LODEvaluator *	lodEvaluator () const
	Returns the installed LODEvaluator (if any) or NULL. More...

int	evaluateLOD (Camera *camera)

void	setEnableMask (unsigned int mask)
	The enable mask of an Actor is usually used to defines whether the actor should be rendered or not depending on the Rendering::enableMask() but it can also be used for user-specific tasks (set to 0xFFFFFFFF by default). More...

unsigned int	enableMask () const
	The enable mask of an Actor is usually used to defines whether the actor should be rendered or not depending on the Rendering::enableMask() but it can also be used for user-specific tasks (set to 0xFFFFFFFF by default). More...

void	setEnabled (bool enabled)
	Whether an Actor should be considered for rendering, picking, scene bounding box calculation etc. More...

bool	isEnabled () const
	Whether an Actor should be considered for rendering, picking, scene bounding box calculation etc. More...

void	setUniform (Uniform *uniform)
	Equivalent to getUniformSet()->setUniform(uniform) More...

const std::vector< ref< Uniform > > &	uniforms () const
	Equivalent to getUniformSet()->uniforms() More...

std::vector< ref< Uniform > > &	uniforms ()
	Equivalent to gocUniformSet()->uniforms() More...

void	eraseUniform (const char *name)
	Equivalent to getUniformSet()->eraseUniform(name) More...

void	eraseUniform (const Uniform *uniform)
	Equivalent to getUniformSet()->eraseUniform(uniform) More...

void	eraseAllUniforms ()
	Equivalent to getUniformSet()->eraseAllUniforms() More...

Uniform *	gocUniform (const char *name)
	Equivalent to getUniformSet()->getUniform(name, get_mode) More...

Uniform *	getUniform (const char *name)
	Equivalent to getUniformSet()->getUniform(name, get_mode) More...

const Uniform *	getUniform (const char *name) const
	Equivalent to getUniformSet()->getUniform(name, get_mode) More...

void	setUniformSet (UniformSet *uniforms)
	Installs a new UniformSet. More...

const UniformSet *	getUniformSet () const
	Returns the installed UniformSet. More...

UniformSet *	getUniformSet ()
	Returns the installed UniformSet. More...

UniformSet *	gocUniformSet ()
	Creates and/or returns the installed UniformSet. More...

const Collection< ActorEventCallback > *	actorEventCallbacks () const
	Returns the list of ActorEventCallback bound to an Actor. More...

Collection< ActorEventCallback > *	actorEventCallbacks ()
	Returns the list of ActorEventCallback bound to an Actor. More...

void	dispatchOnActorRenderStarted (real frame_clock, const Camera camera, Renderable renderable, const Shader *shader, int pass)
	Calls all the onActorRenderStarted() of all the ActorEventCallback installed on this Actor. More...

void	dispatchOnActorDelete ()
	Calls all the onActorDelete() of all the ActorEventCallback installed on this Actor. More...

void	setScissor (Scissor *scissor)
	Sets the Scissor to be used when rendering an Actor. More...

const Scissor *	scissor () const
	Returns the Scissor used when rendering an Actor. More...

Scissor *	scissor ()
	Returns the Scissor used when rendering an Actor. More...

void	setOccludee (bool is_occludee)
	If `is_occludee` equals true an occlusion test will be performed before the rendering of the Actor (if occlusion culling is enabled) otherwise the Actor will always be rendered with no occlusion test even when occlusion culling is enabled. More...

bool	isOccludee () const
	If `is_occludee` equals true an occlusion test will be performed before the rendering of the Actor (if occlusion culling is enabled) otherwise the Actor will always be rendered with no occlusion test even when occlusion culling is enabled. More...

void	createOcclusionQuery ()
	For internal use only. More...

void	deleteOcclusionQuery ()
	For internal use only. More...

GLuint	occlusionQuery () const
	For internal use only. More...

void	setOcclusionQueryTick (unsigned tick)
	For internal use only. More...

unsigned	occlusionQueryTick () const
	For internal use only. More...

Public Member Functions inherited from vl::Object
	Object ()
	Constructor. More...

	Object (const Object &other)
	Copy constructor: copies the name, ref count mutex and user data. More...

Object &	operator= (const Object &other)
	Copy operator: copies the object's name, ref count mutex and user data. More...

const std::string &	objectName () const
	The name of the object, by default set to the object's class name. More...

void	setObjectName (const char *name)
	The name of the object, by default set to the object's class name in debug builds. More...

void	setObjectName (const std::string &name)
	The name of the object, by default set to the object's class name in debug builds. More...

void	setRefCountMutex (IMutex *mutex)
	The mutex used to protect the reference counting of an Object across multiple threads. More...

IMutex *	refCountMutex ()
	The mutex used to protect the reference counting of an Object across multiple threads. More...

const IMutex *	refCountMutex () const
	The mutex used to protect the reference counting of an Object across multiple threads. More...

int	referenceCount () const
	Returns the number of references of an object. More...

void	incReference () const
	Increments the reference count of an object. More...

void	decReference ()
	Decrements the reference count of an object and deletes it if both automaticDelete() is `true` the count reaches 0. More...

void	setAutomaticDelete (bool autodel_on)
	If set to true the Object is deleted when its reference count reaches 0. More...

bool	automaticDelete () const
	If set to true the Object is deleted when its reference count reaches 0. More...

template<class T >
T *	as ()
	Casts an Object to the specified class. More...

template<class T >
const T *	as () const
	Casts an Object to the specified class. More...

Protected Attributes
AABB	mAABB

Sphere	mSphere

ref< Effect >	mEffect

ref< Renderable >	mRenderables [VL_MAX_ACTOR_LOD]

ref< Transform >	mTransform

ref< LODEvaluator >	mLODEvaluator

ref< UniformSet >	mUniformSet

ref< Scissor >	mScissor

Collection< ActorEventCallback >	mActorEventCallbacks

int	mRenderBlock

int	mRenderRank

long long	mTransformUpdateTick

long long	mBoundsUpdateTick

unsigned int	mEnableMask

GLuint	mOcclusionQuery

unsigned	mOcclusionQueryTick

bool	mIsOccludee

bool	mEnabled

Protected Attributes inherited from vl::Object
std::string	mObjectName

IMutex *	mRefCountMutex

int	mReferenceCount

bool	mAutomaticDelete

Additional Inherited Members
Protected Member Functions inherited from vl::Object
virtual	~Object ()

Detailed Description

Associates a Renderable object to an Effect and Transform.

An Actor can associate one Renderable for each LOD (level of detail) using the lods() function. The rendering order of an Actor is defined by its rendering rank, and block, see setRenderRank() and setRenderBlock() for the details.

Note

The same Renderable can be bound to more than one Actor at the same time
The same Effect can be bound to more than one Actor at the same time
The same Transform can be bound to more than one Actor at the same time

Remarks

An Actor must always have a Renderable and Effect bound. If no Transform is specified the Renderable will be rendered as if it had an identity matrix transformation.

Uniforms

The Uniforms defined in the Actor and the ones defined in the Shader must not overlap, that is, an Actor must not define Uniforms that are also present in the Shader's Uniform and vice versa.

See also: Transform, Effect, Renderable, Geometry

Definition at line 130 of file Actor.hpp.

Constructor & Destructor Documentation

◆ Actor()

vl::Actor::Actor	(	Renderable *	renderable = `NULL`,
		Effect *	effect = `NULL`,
		Transform *	transform = `NULL`,
		int	block = `0`,
		int	rank = `0`
	)

inline

Constructor.

Parameters

renderable	A Renderable defining the Actor's LOD level #0
effect	The Effect to be used by the Actor
transform	The Transform to be used by the Actor
block	The rendering block to which the Actor belongs
rank	The rendering rank to which the Actor belongs

Definition at line 142 of file Actor.hpp.

References NULL.

◆ ~Actor()

Actor::~Actor ( )

virtual

Destructor.

Definition at line 39 of file Actor.cpp.

References deleteOcclusionQuery(), and dispatchOnActorDelete().

Member Function Documentation

◆ actorEventCallbacks() [1/2]

const Collection<ActorEventCallback>* vl::Actor::actorEventCallbacks ( ) const

inline

Returns the list of ActorEventCallback bound to an Actor.

Definition at line 370 of file Actor.hpp.

Referenced by vl::RaycastVolume::bindActor(), vl::SlicedVolume::bindActor(), vl::MorphingCallback::bindActor(), vlX::VLXClassWrapper_Actor::exportActor(), and vlX::VLXClassWrapper_Actor::importActor().

◆ actorEventCallbacks() [2/2]

Collection<ActorEventCallback>* vl::Actor::actorEventCallbacks ( )

inline

Returns the list of ActorEventCallback bound to an Actor.

Definition at line 373 of file Actor.hpp.

◆ boundingBox()

const AABB& vl::Actor::boundingBox ( ) const

inline

Returns the bounding box (not guaranteed to be up to date) that contains this Actor.

See also: boundingBoxSafe()

Definition at line 205 of file Actor.hpp.

Referenced by vl::TrackballManipulator::adjustView(), vl::ActorTreeAbstract::computeAABB(), vl::SceneManager::computeBounds(), vl::ActorKdTree::insertActor(), vl::OcclusionCullRenderer::render_pass2(), and vl::SceneManagerPortals::visitSector().

◆ boundingBoxSafe()

const AABB& vl::Actor::boundingBoxSafe ( )

inline

Returns the bounding box (guaranteed to be up to date) that contains this Actor.

See also: boundingBox()

Definition at line 211 of file Actor.hpp.

◆ boundingSphere()

const Sphere& vl::Actor::boundingSphere ( ) const

inline

Returns the bounding sphere (not guaranteed to be up to date) that contains this Actor.

See also: boundingSphereSafe()

Definition at line 208 of file Actor.hpp.

Referenced by vl::SceneManager::computeBounds(), and vl::Rendering::render().

◆ boundingSphereSafe()

const Sphere& vl::Actor::boundingSphereSafe ( )

inline

Returns the bounding sphere (guaranteed to be up to date) that contains this Actor.

See also: boundingSphere()

Definition at line 214 of file Actor.hpp.

◆ boundsDirty()

bool Actor::boundsDirty ( ) const

Returns whether the Actor's bounding box and sphere are up to date.

Definition at line 84 of file Actor.cpp.

References vl::Renderable::boundsDirty(), vl::Renderable::boundsUpdateTick(), lod(), mBoundsUpdateTick, mTransformUpdateTick, transform(), and vl::Transform::worldMatrixUpdateTick().

◆ computeBounds()

void Actor::computeBounds ( )

Computes the bounding box and bounding sphere of an Actor if boundsDirty().

Definition at line 95 of file Actor.cpp.

References vl::Renderable::boundingBox(), vl::Renderable::boundsDirty(), vl::Renderable::boundsUpdateTick(), vl::AABB::isNull(), lod(), mAABB, mBoundsUpdateTick, mSphere, mTransformUpdateTick, transform(), vl::AABB::transformed(), and vl::Transform::worldMatrixUpdateTick().

Referenced by vl::TrackballManipulator::adjustView(), vl::ActorTreeAbstract::computeAABB(), vl::SceneManager::computeBounds(), vl::ActorTreeAbstract::extractVisibleActors(), vl::Rendering::fillRenderQueue(), and vl::SceneManagerPortals::visitSector().

◆ createOcclusionQuery()

void Actor::createOcclusionQuery ( )

For internal use only.

Creates the occlusion query object name bound this Actor using the OpenGL function glGenQueries().

Definition at line 63 of file Actor.cpp.

References vl::Has_Occlusion_Query, mOcclusionQuery, VL_CHECK, and VL_CHECK_OGL.

Referenced by vl::OcclusionCullRenderer::render_pass2().

◆ deleteOcclusionQuery()

void Actor::deleteOcclusionQuery ( )

For internal use only.

Deletes the occlusion query object name using the OpenGL function glDeleteQueries().

Definition at line 72 of file Actor.cpp.

References vl::Has_Occlusion_Query, and mOcclusionQuery.

Referenced by ~Actor().

◆ dispatchOnActorDelete()

void vl::Actor::dispatchOnActorDelete ( )

inline

Calls all the onActorDelete() of all the ActorEventCallback installed on this Actor.

Definition at line 387 of file Actor.hpp.

References vl::ActorEventCallback::onActorDelete().

Referenced by ~Actor().

◆ dispatchOnActorRenderStarted()

void vl::Actor::dispatchOnActorRenderStarted	(	real	frame_clock,
		const Camera *	camera,
		Renderable *	renderable,
		const Shader *	shader,
		int	pass
	)

inline

Calls all the onActorRenderStarted() of all the ActorEventCallback installed on this Actor.

Definition at line 376 of file Actor.hpp.

References vl::ActorEventCallback::isEnabled(), and vl::ActorEventCallback::onActorRenderStarted().

Referenced by vl::Renderer::renderRaw().

◆ effect() [1/2]

Effect* vl::Actor::effect ( )

inline

Returns the Effect bound to an Actor.

Definition at line 199 of file Actor.hpp.

Referenced by vl::VectorGraphics::drawActor(), vlX::VLXClassWrapper_Actor::exportActor(), vl::Rendering::fillRenderQueue(), vl::DaeLoader::load(), and vl::loadAC3D().

◆ effect() [2/2]

const Effect* vl::Actor::effect ( ) const

inline

Returns the Effect bound to an Actor.

Definition at line 202 of file Actor.hpp.

◆ enableMask()

unsigned int vl::Actor::enableMask ( ) const

inline

The enable mask of an Actor is usually used to defines whether the actor should be rendered or not depending on the Rendering::enableMask() but it can also be used for user-specific tasks (set to 0xFFFFFFFF by default).

See also: Actor::enableMask(), Actor::isEnabled(), ActorTreeAbstract::isEnabled(), SceneManager::enableMask(), Rendering::enableMask(), Rendering::effectOverrideMask(), Renderer::enableMask(), Renderer::shaderOverrideMask().

Definition at line 270 of file Actor.hpp.

Referenced by vlX::VLXClassWrapper_Actor::exportActor(), vl::ActorTreeAbstract::extractVisibleActors(), vl::Rendering::fillRenderQueue(), vl::RenderingAbstract::isEnabled(), vl::Renderer::isEnabled(), vl::SceneManager::isEnabled(), and vl::Renderer::renderRaw().

◆ eraseAllUniforms()

void Actor::eraseAllUniforms ( )

Equivalent to getUniformSet()->eraseAllUniforms()

Remarks: You must install a UniformSet with setUniformSet() before calling this function.

Definition at line 129 of file Actor.cpp.

References vl::UniformSet::eraseAllUniforms(), and getUniformSet().

◆ eraseUniform() [1/2]

void Actor::eraseUniform ( const char * name )

Equivalent to getUniformSet()->eraseUniform(name)

Remarks: You must install a UniformSet with setUniformSet() before calling this function.

Definition at line 125 of file Actor.cpp.

References vl::UniformSet::eraseUniform(), and getUniformSet().

◆ eraseUniform() [2/2]

void Actor::eraseUniform ( const Uniform * uniform )

Equivalent to getUniformSet()->eraseUniform(uniform)

Remarks: You must install a UniformSet with setUniformSet() before calling this function.

Definition at line 127 of file Actor.cpp.

References vl::UniformSet::eraseUniform(), and getUniformSet().

◆ evaluateLOD()

int Actor::evaluateLOD ( Camera * camera )

Definition at line 55 of file Actor.cpp.

References mLODEvaluator.

Referenced by vl::Rendering::fillRenderQueue().

◆ getUniform() [1/2]

Uniform * Actor::getUniform ( const char * name )

Equivalent to getUniformSet()->getUniform(name, get_mode)

Remarks: You must install a UniformSet with setUniformSet() before calling this function.

Definition at line 133 of file Actor.cpp.

References vl::UniformSet::getUniform(), getUniformSet(), and NULL.

◆ getUniform() [2/2]

const Uniform * Actor::getUniform ( const char * name ) const

Equivalent to getUniformSet()->getUniform(name, get_mode)

Remarks: You must install a UniformSet with setUniformSet() before calling this function.

Definition at line 135 of file Actor.cpp.

References vl::UniformSet::getUniform(), getUniformSet(), and NULL.

◆ getUniformSet() [1/2]

const UniformSet* vl::Actor::getUniformSet ( ) const

inline

Returns the installed UniformSet.

See also

Definition at line 345 of file Actor.hpp.

Referenced by eraseAllUniforms(), eraseUniform(), vlX::VLXClassWrapper_Actor::exportActor(), getUniform(), vl::Renderer::renderRaw(), and uniforms().

◆ getUniformSet() [2/2]

UniformSet* vl::Actor::getUniformSet ( )

inline

Returns the installed UniformSet.

See also

Definition at line 356 of file Actor.hpp.

◆ gocUniform()

Uniform * Actor::gocUniform ( const char * name )

Equivalent to getUniformSet()->getUniform(name, get_mode)

Remarks: You must install a UniformSet with setUniformSet() before calling this function.

Definition at line 131 of file Actor.cpp.

References vl::UniformSet::gocUniform(), and gocUniformSet().

Referenced by vl::RaycastVolume::updateUniforms(), and vl::SlicedVolume::updateUniforms().

◆ gocUniformSet()

UniformSet* vl::Actor::gocUniformSet ( )

inline

Creates and/or returns the installed UniformSet.

See also

Definition at line 367 of file Actor.hpp.

Referenced by gocUniform(), setUniform(), and uniforms().

◆ isEnabled()

bool vl::Actor::isEnabled ( ) const

inline

Whether an Actor should be considered for rendering, picking, scene bounding box calculation etc.

See also: Actor::enableMask(), Actor::isEnabled(), ActorTreeAbstract::isEnabled(), SceneManager::enableMask(), Rendering::enableMask(), Rendering::effectOverrideMask(), Renderer::enableMask(), Renderer::shaderOverrideMask().

Definition at line 277 of file Actor.hpp.

Referenced by vlX::VLXClassWrapper_Actor::exportActor(), vl::ActorTreeAbstract::extractVisibleActors(), vl::RenderingAbstract::isEnabled(), vl::Renderer::isEnabled(), and vl::SceneManager::isEnabled().

◆ isOccludee()

bool vl::Actor::isOccludee ( ) const

inline

If is_occludee equals true an occlusion test will be performed before the rendering of the Actor (if occlusion culling is enabled) otherwise the Actor will always be rendered with no occlusion test even when occlusion culling is enabled.

Definition at line 427 of file Actor.hpp.

Referenced by vlX::VLXClassWrapper_Actor::exportActor(), and vl::OcclusionCullRenderer::render_pass2().

◆ lod() [1/2]

const Renderable* vl::Actor::lod ( int lod_index ) const

inline

Returns the Renderable object representing the LOD level specifed by lod_index.

Definition at line 173 of file Actor.hpp.

Referenced by vl::TrackballManipulator::adjustView(), boundsDirty(), computeBounds(), vl::DistanceLODEvaluator::evaluate(), vl::PixelLODEvaluator::evaluate(), vlX::VLXClassWrapper_Actor::exportActor(), vl::EdgeExtractor::extractEdges(), vl::Rendering::fillRenderQueue(), vl::ActorKdTree::insertActor(), vl::RayIntersector::intersect(), vl::DaeLoader::load(), and vl::EdgeRenderer::renderSolids().

◆ lod() [2/2]

Renderable* vl::Actor::lod ( int lod_index )

inline

Returns the Renderable object representing the LOD level specifed by lod_index.

Definition at line 176 of file Actor.hpp.

References NULL.

◆ lodEvaluator() [1/2]

LODEvaluator* vl::Actor::lodEvaluator ( )

inline

Returns the installed LODEvaluator (if any) or NULL.

Definition at line 255 of file Actor.hpp.

Referenced by vlX::VLXClassWrapper_Actor::exportActor().

◆ lodEvaluator() [2/2]

const LODEvaluator* vl::Actor::lodEvaluator ( ) const

inline

Returns the installed LODEvaluator (if any) or NULL.

Definition at line 258 of file Actor.hpp.

◆ occlusionQuery()

GLuint vl::Actor::occlusionQuery ( ) const

inline

For internal use only.

Returns the occlusion query object name bound this Actor as by the OpenGL function glGenQueries(). Returns 0 if no query object name has been created yet.

Definition at line 439 of file Actor.hpp.

Referenced by vl::OcclusionCullRenderer::render_pass1(), and vl::OcclusionCullRenderer::render_pass2().

◆ occlusionQueryTick()

unsigned vl::Actor::occlusionQueryTick ( ) const

inline

For internal use only.

Definition at line 445 of file Actor.hpp.

Referenced by vl::OcclusionCullRenderer::render_pass1().

◆ renderBlock()

int vl::Actor::renderBlock ( ) const

inline

Returns the rendering block of an Actor.

Definition at line 249 of file Actor.hpp.

Referenced by vlX::VLXClassWrapper_Actor::exportActor(), vl::RenderQueueSorterBasic::operator()(), vl::RenderQueueSorterStandard::operator()(), vl::RenderQueueSorterOcclusion::operator()(), and vl::RenderQueueSorterAggressive::operator()().

◆ renderRank()

int vl::Actor::renderRank ( ) const

inline

Returns the rendering rank of an Actor.

Definition at line 246 of file Actor.hpp.

Referenced by vlX::VLXClassWrapper_Actor::exportActor(), vl::RenderQueueSorterBasic::operator()(), vl::RenderQueueSorterStandard::operator()(), vl::RenderQueueSorterOcclusion::operator()(), and vl::RenderQueueSorterAggressive::operator()().

◆ scissor() [1/2]

const Scissor* vl::Actor::scissor ( ) const

inline

Returns the Scissor used when rendering an Actor.

See also

Definition at line 411 of file Actor.hpp.

Referenced by vl::OcclusionCullRenderer::render_pass2(), and vl::Renderer::renderRaw().

◆ scissor() [2/2]

Scissor* vl::Actor::scissor ( )

inline

Returns the Scissor used when rendering an Actor.

See also

Definition at line 419 of file Actor.hpp.

◆ setEffect()

void vl::Actor::setEffect ( Effect * effect )

inline

Binds an Effect to an Actor.

Definition at line 196 of file Actor.hpp.

Referenced by vl::VolumePlot::compute(), vl::VectorGraphics::drawActor(), vlX::VLXClassWrapper_Actor::importActor(), vl::DaeLoader::load(), vl::load3DS(), vl::loadAC3D(), and vl::ObjLoader::loadOBJ().

◆ setEnabled()

void vl::Actor::setEnabled ( bool enabled )

inline

Whether an Actor should be considered for rendering, picking, scene bounding box calculation etc.

See also: Actor::enableMask(), Actor::isEnabled(), ActorTreeAbstract::isEnabled(), SceneManager::enableMask(), Rendering::enableMask(), Rendering::effectOverrideMask(), Renderer::enableMask(), Renderer::shaderOverrideMask().

Definition at line 274 of file Actor.hpp.

Referenced by vlX::VLXClassWrapper_Actor::importActor().

◆ setEnableMask()

void vl::Actor::setEnableMask ( unsigned int mask )

inline

The enable mask of an Actor is usually used to defines whether the actor should be rendered or not depending on the Rendering::enableMask() but it can also be used for user-specific tasks (set to 0xFFFFFFFF by default).

See also: Actor::enableMask(), Actor::isEnabled(), ActorTreeAbstract::isEnabled(), SceneManager::enableMask(), Rendering::enableMask(), Rendering::effectOverrideMask(), Renderer::enableMask(), Renderer::shaderOverrideMask().

Definition at line 265 of file Actor.hpp.

Referenced by vlX::VLXClassWrapper_Actor::importActor().

◆ setLod()

void vl::Actor::setLod	(	int	lod_index,
		Renderable *	renderable
	)

inline

Sets the Renderable object representing the LOD level specifed by lod_index.

Definition at line 159 of file Actor.hpp.

Referenced by vl::RaycastVolume::bindActor(), vl::SlicedVolume::bindActor(), vl::MorphingCallback::bindActor(), vl::VolumePlot::compute(), vlX::VLXClassWrapper_Actor::importActor(), vl::loadAC3D(), and setLODs().

◆ setLODEvaluator()

void vl::Actor::setLODEvaluator ( LODEvaluator * lod_evaluator )

inline

Installs the LODEvaluator used to compute the current LOD at rendering time.

Definition at line 252 of file Actor.hpp.

Referenced by vlX::VLXClassWrapper_Actor::importActor().

◆ setLODs()

void Actor::setLODs	(	Renderable *	lod0,
		Renderable *	lod1 = `NULL`,
		Renderable *	lod2 = `NULL`,
		Renderable *	lod3 = `NULL`,
		Renderable *	lod4 = `NULL`,
		Renderable *	lod5 = `NULL`
	)

Utility function to assign one or more Renderable[s] to one or more LOD levels.

Definition at line 45 of file Actor.cpp.

References setLod(), and VL_CHECK.

◆ setOccludee()

void vl::Actor::setOccludee ( bool is_occludee )

inline

If is_occludee equals true an occlusion test will be performed before the rendering of the Actor (if occlusion culling is enabled) otherwise the Actor will always be rendered with no occlusion test even when occlusion culling is enabled.

Definition at line 423 of file Actor.hpp.

Referenced by vlX::VLXClassWrapper_Actor::importActor().

◆ setOcclusionQueryTick()

void vl::Actor::setOcclusionQueryTick ( unsigned tick )

inline

For internal use only.

Definition at line 442 of file Actor.hpp.

Referenced by vl::OcclusionCullRenderer::render_pass2().

◆ setRenderBlock()

void vl::Actor::setRenderBlock ( int block )

inline

Modifies the rendering block of an Actor.

The rendering block affects the order in which an Actor is rendered, the greater the block the later the Actor is rendered. The default render block is zero.

To know more about rendering order please see Rendering Order.

See also: setRenderRank(), Effect::setRenderRank()

Definition at line 243 of file Actor.hpp.

Referenced by vlX::VLXClassWrapper_Actor::importActor().

◆ setRenderRank()

void vl::Actor::setRenderRank ( int rank )

inline

Modifies the rendering rank of an Actor.

The rendering rank affects the order in which an Actor is rendered, the greater the rank the later the Actor is rendered. The default render rank is zero.

To know more about rendering order please see Rendering Order.

See also: setRenderBlock(), Effect::setRenderRank()

Definition at line 231 of file Actor.hpp.

Referenced by vlX::VLXClassWrapper_Actor::importActor().

◆ setScissor()

void vl::Actor::setScissor ( Scissor * scissor )

inline

Sets the Scissor to be used when rendering an Actor.

Note: You can also define a Scissor on a per-Shader basis using the function Shader::setScissor(). In case both the Shader's and the Actor's Scissor are defined the Actor's Scissor is used.

See also

Definition at line 404 of file Actor.hpp.

Referenced by vl::VectorGraphics::popScissor().

◆ setTransform()

void vl::Actor::setTransform ( Transform * transform )

inline

Binds a Transform to an Actor.

Definition at line 182 of file Actor.hpp.

Referenced by vl::VolumePlot::compute(), vl::VectorGraphics::drawActor(), vl::VectorGraphics::drawActorCopy(), and vlX::VLXClassWrapper_Actor::importActor().

◆ setUniform()

void Actor::setUniform ( Uniform * uniform )

Equivalent to getUniformSet()->setUniform(uniform)

Remarks: This function performs a 'setUniformSet(new UniformSet)' if getUniformSet() is NULL.

Definition at line 119 of file Actor.cpp.

References gocUniformSet(), and vl::UniformSet::setUniform().

Referenced by vlX::VLXClassWrapper_Actor::importActor(), and vl::Terrain::init().

◆ setUniformSet()

void vl::Actor::setUniformSet ( UniformSet * uniforms )

inline

Installs a new UniformSet.

See also

Definition at line 334 of file Actor.hpp.

Referenced by vl::Terrain::init().

◆ transform() [1/2]

Transform* vl::Actor::transform ( )

inline

Returns the Transform bound tho an Actor.

Definition at line 190 of file Actor.hpp.

Referenced by vl::TrackballManipulator::adjustView(), vl::Molecule::atomsStyle(), vl::Molecule::ballAndStickStyle(), vl::Text::boundingRectTransformed(), boundsDirty(), computeBounds(), vl::DistanceLODEvaluator::evaluate(), vl::PixelLODEvaluator::evaluate(), vlX::VLXClassWrapper_Actor::exportActor(), vl::RayIntersector::intersectGeometry(), vl::DaeLoader::load(), vl::SlicedVolume::onActorRenderStarted(), vl::EdgeUpdateCallback::onActorRenderStarted(), vl::DepthSortCallback::onActorRenderStarted(), vl::DrawPixels::render_Implementation(), vl::OcclusionCullRenderer::render_pass2(), vl::EdgeRenderer::renderLines(), vl::Renderer::renderRaw(), vl::EdgeRenderer::renderSolids(), vl::Text::renderText(), vl::VolumePlot::setupLabels(), vl::RenderQueue::sort(), vl::Molecule::sticksStyle(), vl::RaycastVolume::updateUniforms(), and vl::SlicedVolume::updateUniforms().

◆ transform() [2/2]

const Transform* vl::Actor::transform ( ) const

inline

Returns the Transform bound tho an Actor.

Definition at line 193 of file Actor.hpp.

◆ uniforms() [1/2]

const std::vector< ref< Uniform > > & Actor::uniforms ( ) const

Equivalent to getUniformSet()->uniforms()

Remarks: You must install a UniformSet with setUniformSet() before calling this function.

Definition at line 121 of file Actor.cpp.

References getUniformSet(), and vl::UniformSet::uniforms().

Referenced by vlX::VLXClassWrapper_Actor::exportActor().

◆ uniforms() [2/2]

std::vector< ref< Uniform > > & Actor::uniforms ( )

Equivalent to gocUniformSet()->uniforms()

Remarks: You must install a UniformSet with setUniformSet() before calling this function.

Definition at line 123 of file Actor.cpp.

References gocUniformSet(), and vl::UniformSet::uniforms().

Member Data Documentation

◆ mAABB

AABB vl::Actor::mAABB

protected

Definition at line 458 of file Actor.hpp.

Referenced by computeBounds().

◆ mActorEventCallbacks

Collection<ActorEventCallback> vl::Actor::mActorEventCallbacks

protected

Definition at line 466 of file Actor.hpp.

◆ mBoundsUpdateTick

long long vl::Actor::mBoundsUpdateTick

protected

Definition at line 470 of file Actor.hpp.

Referenced by boundsDirty(), and computeBounds().

◆ mEffect

ref<Effect> vl::Actor::mEffect

protected

Definition at line 460 of file Actor.hpp.

◆ mEnabled

bool vl::Actor::mEnabled

protected

Definition at line 475 of file Actor.hpp.

◆ mEnableMask

unsigned int vl::Actor::mEnableMask

protected

Definition at line 471 of file Actor.hpp.

◆ mIsOccludee

bool vl::Actor::mIsOccludee

protected

Definition at line 474 of file Actor.hpp.

◆ mLODEvaluator

ref<LODEvaluator> vl::Actor::mLODEvaluator

protected

Definition at line 463 of file Actor.hpp.

Referenced by evaluateLOD().

◆ mOcclusionQuery

GLuint vl::Actor::mOcclusionQuery

protected

Definition at line 472 of file Actor.hpp.

Referenced by createOcclusionQuery(), and deleteOcclusionQuery().

◆ mOcclusionQueryTick

unsigned vl::Actor::mOcclusionQueryTick

protected

Definition at line 473 of file Actor.hpp.

◆ mRenderables

ref<Renderable> vl::Actor::mRenderables[VL_MAX_ACTOR_LOD]

protected

Definition at line 461 of file Actor.hpp.

◆ mRenderBlock

int vl::Actor::mRenderBlock

protected

Definition at line 467 of file Actor.hpp.

◆ mRenderRank

int vl::Actor::mRenderRank

protected

Definition at line 468 of file Actor.hpp.

◆ mScissor

ref<Scissor> vl::Actor::mScissor

protected

Definition at line 465 of file Actor.hpp.

◆ mSphere

Sphere vl::Actor::mSphere

protected

Definition at line 459 of file Actor.hpp.

Referenced by computeBounds().

◆ mTransform

ref<Transform> vl::Actor::mTransform

protected

Definition at line 462 of file Actor.hpp.

◆ mTransformUpdateTick

long long vl::Actor::mTransformUpdateTick

protected

Definition at line 469 of file Actor.hpp.

Referenced by boundsDirty(), and computeBounds().

◆ mUniformSet

ref<UniformSet> vl::Actor::mUniformSet

protected

Definition at line 464 of file Actor.hpp.

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

C:/git/VL/src/vlGraphics/Actor.hpp
C:/git/VL/src/vlGraphics/Actor.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Actor()

◆ ~Actor()

Member Function Documentation

◆ actorEventCallbacks() [1/2]

◆ actorEventCallbacks() [2/2]

◆ boundingBox()

◆ boundingBoxSafe()

◆ boundingSphere()

◆ boundingSphereSafe()

◆ boundsDirty()

◆ computeBounds()

◆ createOcclusionQuery()

◆ deleteOcclusionQuery()

◆ dispatchOnActorDelete()

◆ dispatchOnActorRenderStarted()

◆ effect() [1/2]

◆ effect() [2/2]

◆ enableMask()

◆ eraseAllUniforms()

◆ eraseUniform() [1/2]

◆ eraseUniform() [2/2]

◆ evaluateLOD()

◆ getUniform() [1/2]

◆ getUniform() [2/2]

◆ getUniformSet() [1/2]

◆ getUniformSet() [2/2]

◆ gocUniform()

◆ gocUniformSet()

◆ isEnabled()

◆ isOccludee()

◆ lod() [1/2]

◆ lod() [2/2]

◆ lodEvaluator() [1/2]

◆ lodEvaluator() [2/2]

◆ occlusionQuery()

◆ occlusionQueryTick()

◆ renderBlock()

◆ renderRank()

◆ scissor() [1/2]

◆ scissor() [2/2]

◆ setEffect()

◆ setEnabled()

◆ setEnableMask()

◆ setLod()

◆ setLODEvaluator()

◆ setLODs()

◆ setOccludee()

◆ setOcclusionQueryTick()

◆ setRenderBlock()

◆ setRenderRank()

◆ setScissor()

◆ setTransform()

◆ setUniform()

◆ setUniformSet()

◆ transform() [1/2]

◆ transform() [2/2]

◆ uniforms() [1/2]

◆ uniforms() [2/2]

Member Data Documentation

◆ mAABB

◆ mActorEventCallbacks

◆ mBoundsUpdateTick

◆ mEffect

◆ mEnabled

◆ mEnableMask

◆ mIsOccludee

◆ mLODEvaluator

◆ mOcclusionQuery

◆ mOcclusionQueryTick

◆ mRenderables

◆ mRenderBlock

◆ mRenderRank

◆ mScissor

◆ mSphere

◆ mTransform