The Extrusion class generates a Geometry extruding a silhouette along a path. More...

#include <Extrusion.hpp>

Inheritance diagram for vl::Extrusion:

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

vl::ref< vl::Geometry >	extrude ()
	Performs the actual extrusion. More...

void	setSilhouette (const std::vector< vl::fvec2 > &silhouette)
	Sets the silhouette to be extruded. More...

const std::vector< vl::fvec2 > &	silhouette () const
	Returns the silhouette to be extruded. More...

std::vector< vl::fvec2 > &	silhouette ()
	Returns the silhouette to be extruded. More...

void	setSilhouetteMode (ESilhouetteMode mode)
	Wether the silhouette is considered closed, i.e. a line-loop, or open. More...

ESilhouetteMode	silhouetteMode () const
	Wether the silhouette is considered closed, i.e. a line-loop, or open. More...

void	setSmooth (bool smooth)
	If true the normals of the geometry are smoothed. More...

bool	smooth () const
	If true the normals of the geometry are smoothed. More...

void	setFillBottom (bool fill)
	Whether a set of triangles should be generated to fill the beginning of the extrusion (default is `true`). More...

bool	fillBottom () const
	Whether a set of triangles should be generated to fill the beginning of the extrusion (default is `true`). More...

void	setFillTop (bool fill)
	Whether a set of triangles should be generated to fill the ending of the extrusion (default is `true`). More...

bool	fillTop () const
	Whether a set of triangles should be generated to fill the ending of the extrusion (default is `true`). More...

const std::vector< vl::fvec3 > &	positionPath () const
	The path along which the silhouette is extruded. More...

std::vector< vl::fvec3 > &	positionPath ()
	The path along which the silhouette is extruded. More...

const std::vector< float > &	scalingPath () const
	The scaling to be applied along the extrusion. More...

std::vector< float > &	scalingPath ()
	The scaling to be applied along the extrusion. More...

const std::vector< float > &	rotationPath () const
	The rotation to be applied along the extrusion. More...

std::vector< float > &	rotationPath ()
	The rotation to be applied along the extrusion. More...

const std::vector< vl::fvec4 > &	colorPath () const
	The color to be applied to the extrusion. More...

std::vector< vl::fvec4 > &	colorPath ()
	The color to be applied to the extrusion. 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
std::vector< vl::fvec2 >	mSilhouette

std::vector< vl::fvec3 >	mPositionPath

std::vector< float >	mScalingPath

std::vector< float >	mRotationPath

std::vector< vl::fvec4 >	mColorPath

ESilhouetteMode	mSilhouetteMode

bool	mSmooth

bool	mFillBottom

bool	mFillTop

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

The Extrusion class generates a Geometry extruding a silhouette along a path.

See also

Extrusion Tutorial for a practical example of how to use extrusions.
Interpolator, LinearInterpolator, CatmullRomInterpolator to generate silhouettes and extrusion paths.

Definition at line 53 of file Extrusion.hpp.

Constructor & Destructor Documentation

◆ Extrusion()

vl::Extrusion::Extrusion ( )

inline

Constructor.

Definition at line 59 of file Extrusion.hpp.

References vl::SilhouetteClosed.

Member Function Documentation

◆ colorPath() [1/2]

const std::vector<vl::fvec4>& vl::Extrusion::colorPath ( ) const

inline

The color to be applied to the extrusion.

There must be one color control point for each position control point in the positionPath() with the exclusion of the starting and ending control points, i.e colorPath().size() must be equal to positionPath().size()-2.

Definition at line 123 of file Extrusion.hpp.

Referenced by extrude().

◆ colorPath() [2/2]

std::vector<vl::fvec4>& vl::Extrusion::colorPath ( )

inline

The color to be applied to the extrusion.

There must be one color control point for each position control point in the positionPath() with the exclusion of the starting and ending control points, i.e colorPath().size() must be equal to positionPath().size()-2.

Definition at line 127 of file Extrusion.hpp.

◆ extrude()

ref< Geometry > Extrusion::extrude ( )

Performs the actual extrusion.

Definition at line 38 of file Extrusion.cpp.

References vl::Array< T_VectorType, T_Scalar, T_GL_Size, T_GL_Type >::at(), colorPath(), vl::Geometry::computeNormals(), vl::Tessellator::contours(), vl::Tessellator::contourVerts(), vl::Geometry::convertDrawCallToDrawArrays(), vl::dot(), vl::Geometry::drawCalls(), vl::Log::error(), fillBottom(), fillTop(), vl::ref< T >::get(), vl::Matrix4< float >::getRotation(), vl::DrawElements< arr_type >::indexBuffer(), vl::Array< T_VectorType, T_Scalar, T_GL_Size, T_GL_Type >::initFrom(), vl::Vector3< T_Scalar >::normalize(), vl::normalize(), NULL, positionPath(), vl::PT_QUADS, vl::PT_TRIANGLES, vl::Array< T_VectorType, T_Scalar, T_GL_Size, T_GL_Type >::resize(), rotationPath(), scalingPath(), vl::Geometry::setColorArray(), vl::Geometry::setVertexArray(), vl::Tessellator::setWindingRule(), silhouette(), vl::SilhouetteClosed, silhouetteMode(), vl::ArrayAbstract::size(), smooth(), vl::Tessellator::tessellate(), vl::Tessellator::tessellatedTris(), vl::TW_TESS_WINDING_NONZERO, and vl::Geometry::vertexArray().

◆ fillBottom()

bool vl::Extrusion::fillBottom ( ) const

inline

Whether a set of triangles should be generated to fill the beginning of the extrusion (default is true).

Definition at line 91 of file Extrusion.hpp.

Referenced by extrude().

◆ fillTop()

bool vl::Extrusion::fillTop ( ) const

inline

Whether a set of triangles should be generated to fill the ending of the extrusion (default is true).

Definition at line 96 of file Extrusion.hpp.

Referenced by extrude().

◆ positionPath() [1/2]

const std::vector<vl::fvec3>& vl::Extrusion::positionPath ( ) const

inline

The path along which the silhouette is extruded.

The path starts and ends with one extra control point on each side that define the orientation of the start/end extruded segments.

Definition at line 100 of file Extrusion.hpp.

Referenced by extrude().

◆ positionPath() [2/2]

std::vector<vl::fvec3>& vl::Extrusion::positionPath ( )

inline

The path along which the silhouette is extruded.

The path starts and ends with one extra control point on each side that define the orientation of the start/end extruded segments.

Definition at line 103 of file Extrusion.hpp.

◆ rotationPath() [1/2]

const std::vector<float>& vl::Extrusion::rotationPath ( ) const

inline

The rotation to be applied along the extrusion.

There must be one rotation control point for each position control point in the positionPath() with the exclusion of the starting and ending control points, i.e rotationPath().size() must be equal to positionPath().size()-2.

Definition at line 115 of file Extrusion.hpp.

Referenced by extrude().

◆ rotationPath() [2/2]

std::vector<float>& vl::Extrusion::rotationPath ( )

inline

The rotation to be applied along the extrusion.

There must be one rotation control point for each position control point in the positionPath() with the exclusion of the starting and ending control points, i.e rotationPath().size() must be equal to positionPath().size()-2.

Definition at line 119 of file Extrusion.hpp.

◆ scalingPath() [1/2]

const std::vector<float>& vl::Extrusion::scalingPath ( ) const

inline

The scaling to be applied along the extrusion.

There must be one scaling control point for each position control point in the positionPath() with the exclusion of the starting and ending control points, i.e scalingPath().size() must be equal to positionPath().size()-2.

Definition at line 107 of file Extrusion.hpp.

Referenced by extrude().

◆ scalingPath() [2/2]

std::vector<float>& vl::Extrusion::scalingPath ( )

inline

The scaling to be applied along the extrusion.

There must be one scaling control point for each position control point in the positionPath() with the exclusion of the starting and ending control points, i.e scalingPath().size() must be equal to positionPath().size()-2.

Definition at line 111 of file Extrusion.hpp.

◆ setFillBottom()

void vl::Extrusion::setFillBottom ( bool fill )

inline

Whether a set of triangles should be generated to fill the beginning of the extrusion (default is true).

Definition at line 89 of file Extrusion.hpp.

◆ setFillTop()

void vl::Extrusion::setFillTop ( bool fill )

inline

Whether a set of triangles should be generated to fill the ending of the extrusion (default is true).

Definition at line 94 of file Extrusion.hpp.

◆ setSilhouette()

void vl::Extrusion::setSilhouette ( const std::vector< vl::fvec2 > & silhouette )

inline

Sets the silhouette to be extruded.

Definition at line 72 of file Extrusion.hpp.

◆ setSilhouetteMode()

void vl::Extrusion::setSilhouetteMode ( ESilhouetteMode mode )

inline

Wether the silhouette is considered closed, i.e. a line-loop, or open.

Definition at line 79 of file Extrusion.hpp.

◆ setSmooth()

void vl::Extrusion::setSmooth ( bool smooth )

inline

If true the normals of the geometry are smoothed.

Definition at line 84 of file Extrusion.hpp.

◆ silhouette() [1/2]

const std::vector<vl::fvec2>& vl::Extrusion::silhouette ( ) const

inline

Returns the silhouette to be extruded.

Definition at line 74 of file Extrusion.hpp.

Referenced by extrude().

◆ silhouette() [2/2]

std::vector<vl::fvec2>& vl::Extrusion::silhouette ( )

inline

Returns the silhouette to be extruded.

Definition at line 76 of file Extrusion.hpp.

◆ silhouetteMode()

ESilhouetteMode vl::Extrusion::silhouetteMode ( ) const

inline

Wether the silhouette is considered closed, i.e. a line-loop, or open.

Definition at line 81 of file Extrusion.hpp.

Referenced by extrude().

◆ smooth()

bool vl::Extrusion::smooth ( ) const

inline

If true the normals of the geometry are smoothed.

Definition at line 86 of file Extrusion.hpp.

Referenced by extrude().

Member Data Documentation

◆ mColorPath

std::vector<vl::fvec4> vl::Extrusion::mColorPath

protected

Definition at line 134 of file Extrusion.hpp.

◆ mFillBottom

bool vl::Extrusion::mFillBottom

protected

Definition at line 137 of file Extrusion.hpp.

◆ mFillTop

bool vl::Extrusion::mFillTop

protected

Definition at line 138 of file Extrusion.hpp.

◆ mPositionPath

std::vector<vl::fvec3> vl::Extrusion::mPositionPath

protected

Definition at line 131 of file Extrusion.hpp.

◆ mRotationPath

std::vector<float> vl::Extrusion::mRotationPath

protected

Definition at line 133 of file Extrusion.hpp.

◆ mScalingPath

std::vector<float> vl::Extrusion::mScalingPath

protected

Definition at line 132 of file Extrusion.hpp.

◆ mSilhouette

std::vector<vl::fvec2> vl::Extrusion::mSilhouette

protected

Definition at line 130 of file Extrusion.hpp.

◆ mSilhouetteMode

ESilhouetteMode vl::Extrusion::mSilhouetteMode

protected

Definition at line 135 of file Extrusion.hpp.

◆ mSmooth

bool vl::Extrusion::mSmooth

protected

Definition at line 136 of file Extrusion.hpp.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Extrusion()

Member Function Documentation

◆ colorPath() [1/2]

◆ colorPath() [2/2]

◆ extrude()

◆ fillBottom()

◆ fillTop()

◆ positionPath() [1/2]

◆ positionPath() [2/2]

◆ rotationPath() [1/2]

◆ rotationPath() [2/2]

◆ scalingPath() [1/2]

◆ scalingPath() [2/2]

◆ setFillBottom()

◆ setFillTop()

◆ setSilhouette()

◆ setSilhouetteMode()

◆ setSmooth()

◆ silhouette() [1/2]

◆ silhouette() [2/2]

◆ silhouetteMode()

◆ smooth()

Member Data Documentation

◆ mColorPath

◆ mFillBottom

◆ mFillTop

◆ mPositionPath

◆ mRotationPath

◆ mScalingPath

◆ mSilhouette

◆ mSilhouetteMode

◆ mSmooth