DepthSortCallback sorts the primitives of the Geometry bound to the Actor in which the callback is installed. More...

#include <DepthSortCallback.hpp>

Inheritance diagram for vl::DepthSortCallback:

Public Member Functions
	DepthSortCallback ()
	Constructor. More...

void	onActorDelete (Actor *)
	Event notifying that an Actor is being deleted. More...

virtual void	onActorRenderStarted (Actor actor, real, const Camera cam, Renderable renderable, const Shader , int pass)
	Performs the actual sorting. More...

template<typename T , typename deT >
void	sort (deT *polys, std::vector< Point< T > > &sorted_points, std::vector< Line< T > > &sorted_lines, std::vector< Triangle< T > > &sorted_triangles, std::vector< Quad< T > > &sorted_quads)

ESortMode	sortMode () const

void	setSortMode (ESortMode sort_mode)

void	invalidateCache ()
	Forces sorting at the next rendering. More...

Public Member Functions inherited from vl::ActorEventCallback
	ActorEventCallback ()

void	setEnabled (bool enabled)

bool	isEnabled () const

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
std::vector< vec3 >	mEyeSpaceVerts

std::vector< PrimitiveZ >	mPrimitiveZ

std::vector< PointUInt >	mSortedPointsUInt

std::vector< LineUInt >	mSortedLinesUInt

std::vector< TriangleUInt >	mSortedTrianglesUInt

std::vector< QuadUInt >	mSortedQuadsUInt

std::vector< PointUShort >	mSortedPointsUShort

std::vector< LineUShort >	mSortedLinesUShort

std::vector< TriangleUShort >	mSortedTrianglesUShort

std::vector< QuadUShort >	mSortedQuadsUShort

std::vector< PointUByte >	mSortedPointsUByte

std::vector< LineUByte >	mSortedLinesUByte

std::vector< TriangleUByte >	mSortedTrianglesUByte

std::vector< QuadUByte >	mSortedQuadsUByte

vl::mat4	mCacheMatrix

ESortMode	mSortMode

Protected Attributes inherited from vl::ActorEventCallback
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

DepthSortCallback sorts the primitives of the Geometry bound to the Actor in which the callback is installed.

In order to work properly DepthSortCallback requires the following:

The Actor must be bound to a Geometry or subclass.
Sorts only draw calls of type DrawElementsUInt/UShort/UByte.
Sorts only draw calls with primitive type PT_POINTS, PT_LINES, PT_TRIANGLES, PT_QUADS.
The draw calls should not use primitive restart.

Despite the fact that the condition list seems to be quite limiting it actually covers the most common usage cases. Furthermore the use of DrawElements* and the primitive types PT_POINTS, PT_LINES, PT_TRIANGLES, PT_QUADS grants the maximum flexibility.

Note

This callback works well with different LODs.
This callback works well with multipassing, the sorting is done only once.
Using DrawElementsUShort or DrawElementsUByte might result in a quicker sorting compared to DrawElementsUInt. Is therefore advisable to use them whenever possible.

Remarks

The sorting is based on the position of the vertices as specified by Geometry::vertexArray() and for obvious reasons cannot take into consideration transformations made in the vertex shader or in the geometry shader.
The sorting is performed on a per DrawCall basis. For example, if a Geometry has 2 DrawCall A and B bound to it, then the polygons, lines or points of A will always be rendered before the ones specified by B. If you need the two sets of polygons to be correctly sorted with respect to one another you will need to merge them in one single draw call.

See also: Transparency and Polygon Depth Sorting Tutorial

Definition at line 73 of file DepthSortCallback.hpp.

Constructor & Destructor Documentation

◆ DepthSortCallback()

vl::DepthSortCallback::DepthSortCallback ( )

inline

Constructor.

Definition at line 136 of file DepthSortCallback.hpp.

References setSortMode(), and vl::SM_SortBackToFront.

Member Function Documentation

◆ invalidateCache()

void vl::DepthSortCallback::invalidateCache ( )

inline

Forces sorting at the next rendering.

Definition at line 339 of file DepthSortCallback.hpp.

References mCacheMatrix.

◆ onActorDelete()

void vl::DepthSortCallback::onActorDelete ( Actor * actor )

inlinevirtual

Event notifying that an Actor is being deleted.

Implements vl::ActorEventCallback.

Definition at line 142 of file DepthSortCallback.hpp.

◆ onActorRenderStarted()

virtual void vl::DepthSortCallback::onActorRenderStarted	(	Actor *	actor,
		real	,
		const Camera *	cam,
		Renderable *	renderable,
		const Shader *	,
		int	pass
	)

inlinevirtual

◆ setSortMode()

void vl::DepthSortCallback::setSortMode ( ESortMode sort_mode )

inline

Definition at line 334 of file DepthSortCallback.hpp.

References mSortMode.

Referenced by DepthSortCallback().

◆ sort()

template<typename T , typename deT >

void vl::DepthSortCallback::sort	(	deT *	polys,
		std::vector< Point< T > > &	sorted_points,
		std::vector< Line< T > > &	sorted_lines,
		std::vector< Triangle< T > > &	sorted_triangles,
		std::vector< Quad< T > > &	sorted_quads
	)

inline

Definition at line 200 of file DepthSortCallback.hpp.

References vl::BU_DYNAMIC_DRAW, vl::Has_BufferObject, mEyeSpaceVerts, mPrimitiveZ, vl::PT_LINES, vl::PT_POINTS, vl::PT_QUADS, vl::PT_TRIANGLES, vl::SM_SortBackToFront, and sortMode().

◆ sortMode()

ESortMode vl::DepthSortCallback::sortMode ( ) const

inline

Definition at line 333 of file DepthSortCallback.hpp.

References mSortMode.

Referenced by vlX::VLXClassWrapper_ActorEventCallback::exportActorEventCallback(), and sort().

Member Data Documentation

◆ mCacheMatrix

vl::mat4 vl::DepthSortCallback::mCacheMatrix

protected

Definition at line 360 of file DepthSortCallback.hpp.

Referenced by invalidateCache(), and onActorRenderStarted().

◆ mEyeSpaceVerts

std::vector<vec3> vl::DepthSortCallback::mEyeSpaceVerts

protected

Definition at line 342 of file DepthSortCallback.hpp.

Referenced by onActorRenderStarted(), and sort().

◆ mPrimitiveZ

std::vector<PrimitiveZ> vl::DepthSortCallback::mPrimitiveZ

protected

Definition at line 343 of file DepthSortCallback.hpp.

Referenced by sort().

◆ mSortedLinesUByte

std::vector<LineUByte> vl::DepthSortCallback::mSortedLinesUByte

protected

Definition at line 356 of file DepthSortCallback.hpp.

Referenced by onActorRenderStarted().

◆ mSortedLinesUInt

std::vector<LineUInt> vl::DepthSortCallback::mSortedLinesUInt

protected

Definition at line 346 of file DepthSortCallback.hpp.

Referenced by onActorRenderStarted().

◆ mSortedLinesUShort

std::vector<LineUShort> vl::DepthSortCallback::mSortedLinesUShort

protected

Definition at line 351 of file DepthSortCallback.hpp.

Referenced by onActorRenderStarted().

◆ mSortedPointsUByte

std::vector<PointUByte> vl::DepthSortCallback::mSortedPointsUByte

protected

Definition at line 355 of file DepthSortCallback.hpp.

Referenced by onActorRenderStarted().

◆ mSortedPointsUInt

std::vector<PointUInt> vl::DepthSortCallback::mSortedPointsUInt

protected

Definition at line 345 of file DepthSortCallback.hpp.

Referenced by onActorRenderStarted().

◆ mSortedPointsUShort

std::vector<PointUShort> vl::DepthSortCallback::mSortedPointsUShort

protected

Definition at line 350 of file DepthSortCallback.hpp.

Referenced by onActorRenderStarted().

◆ mSortedQuadsUByte

std::vector<QuadUByte> vl::DepthSortCallback::mSortedQuadsUByte

protected

Definition at line 358 of file DepthSortCallback.hpp.

Referenced by onActorRenderStarted().

◆ mSortedQuadsUInt

std::vector<QuadUInt> vl::DepthSortCallback::mSortedQuadsUInt

protected

Definition at line 348 of file DepthSortCallback.hpp.

Referenced by onActorRenderStarted().

◆ mSortedQuadsUShort

std::vector<QuadUShort> vl::DepthSortCallback::mSortedQuadsUShort

protected

Definition at line 353 of file DepthSortCallback.hpp.

Referenced by onActorRenderStarted().

◆ mSortedTrianglesUByte

std::vector<TriangleUByte> vl::DepthSortCallback::mSortedTrianglesUByte

protected

Definition at line 357 of file DepthSortCallback.hpp.

Referenced by onActorRenderStarted().

◆ mSortedTrianglesUInt

std::vector<TriangleUInt> vl::DepthSortCallback::mSortedTrianglesUInt

protected

Definition at line 347 of file DepthSortCallback.hpp.

Referenced by onActorRenderStarted().

◆ mSortedTrianglesUShort

std::vector<TriangleUShort> vl::DepthSortCallback::mSortedTrianglesUShort

protected

Definition at line 352 of file DepthSortCallback.hpp.

Referenced by onActorRenderStarted().

◆ mSortMode

ESortMode vl::DepthSortCallback::mSortMode

protected

Definition at line 362 of file DepthSortCallback.hpp.

Referenced by setSortMode(), and sortMode().

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

C:/git/VL/src/vlGraphics/DepthSortCallback.hpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DepthSortCallback()

Member Function Documentation

◆ invalidateCache()

◆ onActorDelete()

◆ onActorRenderStarted()

◆ setSortMode()

◆ sort()

◆ sortMode()

Member Data Documentation

◆ mCacheMatrix

◆ mEyeSpaceVerts

◆ mPrimitiveZ

◆ mSortedLinesUByte

◆ mSortedLinesUInt

◆ mSortedLinesUShort

◆ mSortedPointsUByte

◆ mSortedPointsUInt

◆ mSortedPointsUShort

◆ mSortedQuadsUByte

◆ mSortedQuadsUInt

◆ mSortedQuadsUShort

◆ mSortedTrianglesUByte

◆ mSortedTrianglesUInt

◆ mSortedTrianglesUShort

◆ mSortMode