Loading options used by LoadWriterDae and DaeLoader. More...

#include <ioDae.hpp>

Inheritance diagram for vl::LoadWriterDae::LoadOptions:

Public Types
enum	TransparencyOption { TransparencyKeep, TransparencyInvert, TransparencyAuto }

Public Member Functions
	LoadOptions ()

void	setFlattenTransformHierarchy (bool flatten)
	If true the <node>'s transform hierachy is flattened and baked inside the Actor::transform(), otherwise the full transform tree is exported. Enabled by default. More...

bool	flattenTransformHierarchy () const
	If true the <node>'s transform hierachy is flattened and baked inside the Actor::transform(), otherwise the full transform tree is exported. Enabled by default. More...

void	setUseAlwaysMipmapping (bool use)
	If true then TPF_LINEAR_MIPMAP_NEAREST filtering is used when a non-mipmapped filter is specified. Enabled by default. More...

bool	useAlwaysMipmapping () const
	If true then TPF_LINEAR_MIPMAP_NEAREST filtering is used when a non-mipmapped filter is specified. Enabled by default. More...

void	setInvertTransparency (TransparencyOption invert)
	Invert the value of the <transparency> tag. Set to TransparencyAuto by default. More...

TransparencyOption	invertTransparency () const
	Invert the value of the <transparency> tag. Set to TransparencyAuto by default. More...

void	setComputeMissingNormals (bool compute)
	Compute normals for those objects that don't have. Enabled by default. More...

bool	computeMissingNormals () const
	Compute normals for those objects that don't have. Enabled by default. More...

void	setFixBadNormals (bool fix)
	Fix normals that are flipped compared to the polygon winding order. Enabled by default. More...

bool	fixBadNormals () const
	Fix normals that are flipped compared to the polygon winding order. Enabled by default. More...

void	setExtractSkins (bool extract)
	If set to true the skinned geometries will be also exported. Enabled by default. More...

bool	extractSkins () const
	If set to true the skinned geometries will be also exported. Enabled by default. More...

void	setMergeDrawCalls (bool merge)
	If set to true merges all the draw calls of each Geometry into one triangle and/or one triangle strip draw call. Enabled by default. More...

bool	mergeDrawCalls () const
	If set to true merges all the draw calls of each Geometry into one triangle and/or one triangle strip draw call. Enabled by default. More...

void	setLightMeshSize (float size)
	If size != 0 a mesh will be generated and exported for each light source. More...

float	lightMeshSize () const
	If size != 0 a mesh will be generated and exported for each light source. More...

void	setExportLights (bool exp_lights)
	If true the lights contained in the COLLADA file will be exported otherwise one single dummy light will be used to lit the models. More...

bool	exportLights () const
	If true the lights contained in the COLLADA file will be exported otherwise one single dummy light will be used to lit the models. 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
TransparencyOption	mInvertTransparency

bool	mFlattenTransformHierarchy

bool	mUseAlwaysMipmapping

bool	mComputeMissingNormals

bool	mFixBadNormals

bool	mExtractSkins

bool	mMergeDrawCalls

float	mLightMeshSize

bool	mExportLights

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

Loading options used by LoadWriterDae and DaeLoader.

Definition at line 54 of file ioDae.hpp.

Member Enumeration Documentation

◆ TransparencyOption

enum vl::LoadWriterDae::LoadOptions::TransparencyOption

Enumerator
TransparencyKeep	< Keep the <transparency> value as it is.
TransparencyInvert	< Transparency becomes 1.0 - <transparency>.
TransparencyAuto	< Transparency is inverted if <authoring_tool> contains the string "Google" or reports ColladaMax or ColladaMaya version less than 3.03.

Definition at line 57 of file ioDae.hpp.

Constructor & Destructor Documentation

◆ LoadOptions()

vl::LoadWriterDae::LoadOptions::LoadOptions ( )

inline

Definition at line 65 of file ioDae.hpp.

References mComputeMissingNormals, mExportLights, mExtractSkins, mFixBadNormals, mFlattenTransformHierarchy, mInvertTransparency, mLightMeshSize, mMergeDrawCalls, mUseAlwaysMipmapping, and TransparencyAuto.

Referenced by vl::LoadWriterDae::LoadWriterDae().

Member Function Documentation

◆ computeMissingNormals()

bool vl::LoadWriterDae::LoadOptions::computeMissingNormals ( ) const

inline

Compute normals for those objects that don't have. Enabled by default.

Definition at line 100 of file ioDae.hpp.

References mComputeMissingNormals.

Referenced by vl::DaeLoader::load().

◆ exportLights()

bool vl::LoadWriterDae::LoadOptions::exportLights ( ) const

inline

If true the lights contained in the COLLADA file will be exported otherwise one single dummy light will be used to lit the models.

Definition at line 134 of file ioDae.hpp.

References mExportLights.

◆ extractSkins()

bool vl::LoadWriterDae::LoadOptions::extractSkins ( ) const

inline

If set to true the skinned geometries will be also exported. Enabled by default.

Definition at line 112 of file ioDae.hpp.

References mExtractSkins.

Referenced by vl::DaeLoader::parseNode().

◆ fixBadNormals()

bool vl::LoadWriterDae::LoadOptions::fixBadNormals ( ) const

inline

Fix normals that are flipped compared to the polygon winding order. Enabled by default.

Definition at line 106 of file ioDae.hpp.

References mFixBadNormals.

Referenced by vl::DaeLoader::generateGeometry().

◆ flattenTransformHierarchy()

bool vl::LoadWriterDae::LoadOptions::flattenTransformHierarchy ( ) const

inline

If true the <node>'s transform hierachy is flattened and baked inside the Actor::transform(), otherwise the full transform tree is exported. Enabled by default.

Definition at line 82 of file ioDae.hpp.

References mFlattenTransformHierarchy.

◆ invertTransparency()

TransparencyOption vl::LoadWriterDae::LoadOptions::invertTransparency ( ) const

inline

Invert the value of the <transparency> tag. Set to TransparencyAuto by default.

Definition at line 94 of file ioDae.hpp.

References mInvertTransparency.

◆ lightMeshSize()

float vl::LoadWriterDae::LoadOptions::lightMeshSize ( ) const

inline

If size != 0 a mesh will be generated and exported for each light source.

If size == 0 no light-mesh will be generated. The generated meshes will be a sphere for point lights, a pyramid for directional light, a cone for spotlights, a torus for ambient lights. Such meshes will be renamed "LightMesh-"+<name of="" the="" light="" object="" they="" represent>="">.

Definition at line 128 of file ioDae.hpp.

References mLightMeshSize.

◆ mergeDrawCalls()

bool vl::LoadWriterDae::LoadOptions::mergeDrawCalls ( ) const

inline

If set to true merges all the draw calls of each Geometry into one triangle and/or one triangle strip draw call. Enabled by default.

Definition at line 118 of file ioDae.hpp.

References mMergeDrawCalls.

◆ setComputeMissingNormals()

void vl::LoadWriterDae::LoadOptions::setComputeMissingNormals ( bool compute )

inline

Compute normals for those objects that don't have. Enabled by default.

Definition at line 97 of file ioDae.hpp.

References mComputeMissingNormals.

◆ setExportLights()

void vl::LoadWriterDae::LoadOptions::setExportLights ( bool exp_lights )

inline

If true the lights contained in the COLLADA file will be exported otherwise one single dummy light will be used to lit the models.

Definition at line 131 of file ioDae.hpp.

References mExportLights.

◆ setExtractSkins()

void vl::LoadWriterDae::LoadOptions::setExtractSkins ( bool extract )

inline

If set to true the skinned geometries will be also exported. Enabled by default.

Definition at line 109 of file ioDae.hpp.

References mExtractSkins.

◆ setFixBadNormals()

void vl::LoadWriterDae::LoadOptions::setFixBadNormals ( bool fix )

inline

Fix normals that are flipped compared to the polygon winding order. Enabled by default.

Definition at line 103 of file ioDae.hpp.

References mFixBadNormals.

◆ setFlattenTransformHierarchy()

void vl::LoadWriterDae::LoadOptions::setFlattenTransformHierarchy ( bool flatten )

inline

If true the <node>'s transform hierachy is flattened and baked inside the Actor::transform(), otherwise the full transform tree is exported. Enabled by default.

Definition at line 79 of file ioDae.hpp.

References mFlattenTransformHierarchy.

◆ setInvertTransparency()

void vl::LoadWriterDae::LoadOptions::setInvertTransparency ( TransparencyOption invert )

inline

Invert the value of the <transparency> tag. Set to TransparencyAuto by default.

Definition at line 91 of file ioDae.hpp.

References mInvertTransparency.

◆ setLightMeshSize()

void vl::LoadWriterDae::LoadOptions::setLightMeshSize ( float size )

inline

If size != 0 a mesh will be generated and exported for each light source.

If size == 0 no light-mesh will be generated. The generated meshes will be a sphere for point lights, a pyramid for directional light, a cone for spotlights, a torus for ambient lights. Such meshes will be renamed "LightMesh-"+<name of="" the="" light="" object="" they="" represent>="">.

Definition at line 123 of file ioDae.hpp.

References mLightMeshSize.

◆ setMergeDrawCalls()

void vl::LoadWriterDae::LoadOptions::setMergeDrawCalls ( bool merge )

inline

If set to true merges all the draw calls of each Geometry into one triangle and/or one triangle strip draw call. Enabled by default.

Definition at line 115 of file ioDae.hpp.

References mMergeDrawCalls.

◆ setUseAlwaysMipmapping()

void vl::LoadWriterDae::LoadOptions::setUseAlwaysMipmapping ( bool use )

inline

If true then TPF_LINEAR_MIPMAP_NEAREST filtering is used when a non-mipmapped filter is specified. Enabled by default.

Definition at line 85 of file ioDae.hpp.

References mUseAlwaysMipmapping.

◆ useAlwaysMipmapping()

bool vl::LoadWriterDae::LoadOptions::useAlwaysMipmapping ( ) const

inline

If true then TPF_LINEAR_MIPMAP_NEAREST filtering is used when a non-mipmapped filter is specified. Enabled by default.

Definition at line 88 of file ioDae.hpp.

References mUseAlwaysMipmapping.

Member Data Documentation

◆ mComputeMissingNormals

bool vl::LoadWriterDae::LoadOptions::mComputeMissingNormals

protected

Definition at line 140 of file ioDae.hpp.

Referenced by computeMissingNormals(), LoadOptions(), and setComputeMissingNormals().

◆ mExportLights

bool vl::LoadWriterDae::LoadOptions::mExportLights

protected

Definition at line 145 of file ioDae.hpp.

Referenced by exportLights(), LoadOptions(), and setExportLights().

◆ mExtractSkins

bool vl::LoadWriterDae::LoadOptions::mExtractSkins

protected

Definition at line 142 of file ioDae.hpp.

Referenced by extractSkins(), LoadOptions(), and setExtractSkins().

◆ mFixBadNormals

bool vl::LoadWriterDae::LoadOptions::mFixBadNormals

protected

Definition at line 141 of file ioDae.hpp.

Referenced by fixBadNormals(), LoadOptions(), and setFixBadNormals().

◆ mFlattenTransformHierarchy

bool vl::LoadWriterDae::LoadOptions::mFlattenTransformHierarchy

protected

Definition at line 138 of file ioDae.hpp.

Referenced by flattenTransformHierarchy(), LoadOptions(), and setFlattenTransformHierarchy().

◆ mInvertTransparency

TransparencyOption vl::LoadWriterDae::LoadOptions::mInvertTransparency

protected

Definition at line 137 of file ioDae.hpp.

Referenced by invertTransparency(), LoadOptions(), and setInvertTransparency().

◆ mLightMeshSize

float vl::LoadWriterDae::LoadOptions::mLightMeshSize

protected

Definition at line 144 of file ioDae.hpp.

Referenced by lightMeshSize(), LoadOptions(), and setLightMeshSize().

◆ mMergeDrawCalls

bool vl::LoadWriterDae::LoadOptions::mMergeDrawCalls

protected

Definition at line 143 of file ioDae.hpp.

Referenced by LoadOptions(), mergeDrawCalls(), and setMergeDrawCalls().

◆ mUseAlwaysMipmapping

bool vl::LoadWriterDae::LoadOptions::mUseAlwaysMipmapping

protected

Definition at line 139 of file ioDae.hpp.

Referenced by LoadOptions(), setUseAlwaysMipmapping(), and useAlwaysMipmapping().

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

C:/git/VL/src/vlGraphics/plugins/COLLADA/ioDae.hpp

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TransparencyOption

Constructor & Destructor Documentation

◆ LoadOptions()

Member Function Documentation

◆ computeMissingNormals()

◆ exportLights()

◆ extractSkins()

◆ fixBadNormals()

◆ flattenTransformHierarchy()

◆ invertTransparency()

◆ lightMeshSize()

◆ mergeDrawCalls()

◆ setComputeMissingNormals()

◆ setExportLights()

◆ setExtractSkins()

◆ setFixBadNormals()

◆ setFlattenTransformHierarchy()

◆ setInvertTransparency()

◆ setLightMeshSize()

◆ setMergeDrawCalls()

◆ setUseAlwaysMipmapping()

◆ useAlwaysMipmapping()

Member Data Documentation

◆ mComputeMissingNormals

◆ mExportLights

◆ mExtractSkins

◆ mFixBadNormals

◆ mFlattenTransformHierarchy

◆ mInvertTransparency

◆ mLightMeshSize

◆ mMergeDrawCalls

◆ mUseAlwaysMipmapping