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:

Classes
class	Line
class	Point
class	PrimitiveZ
class	Quad
class	Sorter_Back_To_Front
class	Sorter_Front_To_Back
class	Triangle
Public Member Functions
	DepthSortCallback ()
	Constructor.
void	onActorDelete (Actor *)
	Event notifying that an Actor is being deleted.
virtual void	onActorRenderStarted (Actor actor, real, const Camera cam, Renderable renderable, const Shader , int pass)
	Performs the actual sorting.
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.
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

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() or vertexAttribArray(vl::VA_Position) 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 74 of file DepthSortCallback.hpp.

Constructor & Destructor Documentation

vl::DepthSortCallback::DepthSortCallback ( ) [inline]

Constructor.

Definition at line 137 of file DepthSortCallback.hpp.

References setSortMode(), vl::SM_SortBackToFront, and VL_DEBUG_SET_OBJECT_NAME.

Member Function Documentation

void vl::DepthSortCallback::onActorDelete ( Actor * actor ) [inline, virtual]

Event notifying that an Actor is being deleted.

Implements vl::ActorEventCallback.

Definition at line 143 of file DepthSortCallback.hpp.

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

Performs the actual sorting.

Implements vl::ActorEventCallback.

Definition at line 146 of file DepthSortCallback.hpp.

References vl::Object::as(), vl::Collection< T >::at(), vl::VertexAttribInfo::data(), vl::Geometry::drawCalls(), vl::ArrayAbstract::getAsVec3(), mCacheMatrix, mEyeSpaceVerts, mSortedLinesUByte, mSortedLinesUInt, mSortedLinesUShort, mSortedPointsUByte, mSortedPointsUInt, mSortedPointsUShort, mSortedQuadsUByte, mSortedQuadsUInt, mSortedQuadsUShort, mSortedTrianglesUByte, mSortedTrianglesUInt, mSortedTrianglesUShort, NULL, vl::Renderable::setBufferObjectDirty(), vl::Renderable::setDisplayListDirty(), vl::Collection< T >::size(), vl::ArrayAbstract::size(), vl::Actor::transform(), vl::VA_Position, vl::Geometry::vertexArray(), vl::Geometry::vertexAttribArray(), vl::Camera::viewMatrix(), and vl::Transform::worldMatrix().

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]`