Model tools functions class. More...

#include <tdme/utilities/ModelTools.h>

Collaboration diagram for ModelTools:

Public Types
enum	VertexOrder { VERTEXORDER_CLOCKWISE , VERTEXORDER_COUNTERCLOCKWISE }

Static Public Member Functions
static VertexOrder	determineVertexOrder (const vector< Vector3 > &vertices)
	Determines vertex order of face. More...

static Vector3	computeNormal (const array< Vector3, 3 > &vertices)
	Computes face normal for given face vertices. More...

static array< Vector3, 3 >	computeNormals (const array< Vector3, 3 > &vertices)
	Computes face normals for given face vertices these normals will not be smooth. More...

static void	prepareForIndexedRendering (Model *model)
	Prepare for indexed rendering. More...

static void	setupJoints (Model *model)
	Set up joints for skinning nodes. More...

static void	fixAnimationLength (Model *model)
	Fix animation length. More...

static bool	hasDefaultAnimation (Model *model)
	Check default animation. More...

static void	createDefaultAnimation (Model *model, int32_t frames)
	Create default animation. More...

static Material *	cloneMaterial (const Material *material, const string &id=string())
	Clone material. More...

static void	cloneNode (Node sourceNode, Model targetModel, Node *targetParentNode=nullptr, bool cloneMesh=true)
	Create model from source sub nodes into target sub nodes. More...

static void	partition (Model model, const Transformations &transformations, map< string, Model > &modelsByPartition, map< string, Vector3 > &modelsPosition)
	Partition model. More...

static void	shrinkToFit (Model *model)
	Shrink to fit. More...

static void	computeNormals (Model model, ProgressCallback progressCallback=nullptr)
	Compute normals. More...

static void	prepareForShader (Model *model, const string &shader)
	Prepare model for foliage shader. More...

static bool	isOptimizedModel (Model *model)

static Model *	optimizeModel (Model *model, const string &texturePathName=string(), const vector< string > &excludeDiffuseTextureFileNamePatterns=vector< string >())
	Optimizes model in terms of material / node reduction. More...

static void	createTangentsAndBitangents (Node *node)
	Create tangents and bitangents for given group. More...

Static Private Member Functions
static void	prepareForIndexedRendering (const map< string, Node * > &nodes)
	Prepares this node for indexed rendering. More...

static void	prepareForIndexedRendering (Skinning *skinning, const vector< int32_t > &vertexMapping, int32_t vertices)
	Maps original vertices to new vertice mapping. More...

static void	setJoint (Node *root)
	Sets up a node as joint taking all subnodes into account. More...

static void	fixAnimationLength (Node *root, int32_t frames)
	Fixes animation length as sometimes they are only given partially, which is not supported by engine. More...

static void	partitionNode (Node sourceNode, map< string, Model > &modelsByPartition, map< string, Vector3 > &modelsPosition, const Matrix4x4 &parentTransformationsMatrix)
	Partition sub nodes. More...

static void	shrinkToFit (Node *node)
	Shrink to fit node. More...

static bool	interpolateNormal (Node *node, const Vector3 &vertex, const vector< Vector3 > &normals, Vector3 &normal)
	Find all faces that include vertex and compute the avarage normal. More...

static float	computeNormals (Node node, ProgressCallback progressCallback=nullptr, float incrementPerFace=0.0f, float progress=0.0f)
	Compute normals. More...

static int	determineFaceCount (Node *node)
	Compute face count. More...

static void	prepareForDefaultShader (Node *node)
	Prepare node for default shader. More...

static void	prepareForFoliageTreeShader (Node *node, const Matrix4x4 &parentTransformationsMatrix, const string &shader)
	Prepare node for foliage shader. More...

static void	prepareForWaterShader (Node *node, const Matrix4x4 &parentTransformationsMatrix)
	Prepare node for water shader. More...

static void	checkForOptimization (Node *node, map< string, int > &materialUseCount, const vector< string > &excludeDiffuseTextureFileNamePatterns)
	Check for optimization. More...

static void	prepareForOptimization (Node *node, const Matrix4x4 &parentTransformationsMatrix)
	Prepare for optimization. More...

static Texture *	createAtlasTexture (const string &id, map< int, Texture * > &textureAtlasTextures)
	Create atlas texture. More...

static void	optimizeNode (Node sourceNode, Model targetModel, int diffuseTextureAtlasSize, const map< string, int > &diffuseTextureAtlasIndices, const vector< string > &excludeDiffuseTextureFileNamePatterns)
	Prepare for optimization. More...

Detailed Description

Model tools functions class.

Author: Andreas Drewke

Definition at line 37 of file ModelTools.h.

Member Enumeration Documentation

◆ VertexOrder

enum VertexOrder

Enumerator
VERTEXORDER_CLOCKWISE
VERTEXORDER_COUNTERCLOCKWISE

Definition at line 41 of file ModelTools.h.

Member Function Documentation

◆ checkForOptimization()

void checkForOptimization	(	Node *	node,
		map< string, int > &	materialUseCount,
		const vector< string > &	excludeDiffuseTextureFileNamePatterns
	)

staticprivate

Check for optimization.

Parameters

node	node
materialUseCount	material use count
excludeDiffuseTextureFileNamePatterns	exclude diffuse texture file name patterns

Definition at line 825 of file ModelTools.cpp.

◆ cloneMaterial()

Material * cloneMaterial	(	const Material *	material,
		const string &	id = `string()`
	)

static

Clone material.

Parameters

material	material
id	new id to use

Returns: material

Definition at line 280 of file ModelTools.cpp.

◆ cloneNode()

void cloneNode	(	Node *	sourceNode,
		Model *	targetModel,
		Node *	targetParentNode = `nullptr`,
		bool	cloneMesh = `true`
	)

static

Create model from source sub nodes into target sub nodes.

Parameters

sourceNode	source node
targetModel	target model
targetParentNode	target parent node
cloneMesh	clone mesh

Definition at line 321 of file ModelTools.cpp.

◆ computeNormal()

static Vector3 computeNormal ( const array< Vector3, 3 > & vertices )

inlinestatic

Computes face normal for given face vertices.

Parameters

vertices face vertices

Returns: computed face normal

Definition at line 55 of file ModelTools.h.

◆ computeNormals() [1/3]

static array< Vector3, 3 > computeNormals ( const array< Vector3, 3 > & vertices )

inlinestatic

Computes face normals for given face vertices these normals will not be smooth.

Parameters

vertices face vertices

Returns: normals computed face normals

Definition at line 78 of file ModelTools.h.

◆ computeNormals() [2/3]

void computeNormals	(	Model *	model,
		ProgressCallback *	progressCallback = `nullptr`
	)

static

Compute normals.

Parameters

node node

Definition at line 693 of file ModelTools.cpp.

◆ computeNormals() [3/3]

float computeNormals	(	Node *	node,
		ProgressCallback *	progressCallback = `nullptr`,
		float	incrementPerFace = `0.0f`,
		float	progress = `0.0f`
	)

staticprivate

Compute normals.

Parameters

node node

Definition at line 644 of file ModelTools.cpp.

◆ createAtlasTexture()

Texture * createAtlasTexture	(	const string &	id,
		map< int, Texture * > &	textureAtlasTextures
	)

staticprivate

Create atlas texture.

Parameters

id	id
textureAtlasTextures	texture atlas textures

Definition at line 1094 of file ModelTools.cpp.

◆ createDefaultAnimation()

void createDefaultAnimation	(	Model *	model,
		int32_t	frames
	)

static

Create default animation.

Parameters

model	model
frames	frames

Definition at line 262 of file ModelTools.cpp.

◆ createTangentsAndBitangents()

void createTangentsAndBitangents ( Node * node )

static

Create tangents and bitangents for given group.

Parameters

node node

Definition at line 1345 of file ModelTools.cpp.

◆ determineFaceCount()

int determineFaceCount ( Node * node )

staticprivate

Compute face count.

Parameters

node node

Definition at line 708 of file ModelTools.cpp.

◆ determineVertexOrder()

ModelTools::VertexOrder determineVertexOrder ( const vector< Vector3 > & vertices )

static

Determines vertex order of face.

Parameters

vertices vertices

Returns: vertex order

Definition at line 68 of file ModelTools.cpp.

◆ fixAnimationLength() [1/2]

void fixAnimationLength ( Model * model )

static

Fix animation length.

Parameters

model model

Definition at line 222 of file ModelTools.cpp.

◆ fixAnimationLength() [2/2]

void fixAnimationLength	(	Node *	root,
		int32_t	frames
	)

staticprivate

Fixes animation length as sometimes they are only given partially, which is not supported by engine.

Parameters

root	node
frames	frames

Definition at line 234 of file ModelTools.cpp.

◆ hasDefaultAnimation()

bool hasDefaultAnimation ( Model * model )

static

Check default animation.

Parameters

model model

Returns: if animation exists

Definition at line 258 of file ModelTools.cpp.

◆ interpolateNormal()

static bool interpolateNormal	(	Node *	node,
		const Vector3 &	vertex,
		const vector< Vector3 > &	normals,
		Vector3 &	normal
	)

inlinestaticprivate

Find all faces that include vertex and compute the avarage normal.

Parameters

node	node
vertex	vertex
normals	normals
normal	normal

Definition at line 204 of file ModelTools.h.

◆ isOptimizedModel()

bool isOptimizedModel ( Model * model )

static

Returns: if model has been optimized

Definition at line 1156 of file ModelTools.cpp.

◆ optimizeModel()

Model * optimizeModel	(	Model *	model,
		const string &	texturePathName = `string()`,
		const vector< string > &	excludeDiffuseTextureFileNamePatterns = `vector<string>()`
	)

static

Optimizes model in terms of material / node reduction.

Parameters

model	model
texturePathName	texturePathName
excludeDiffuseTextureFileNamePatterns	exclude diffuse texture file name patterns

Definition at line 1160 of file ModelTools.cpp.

◆ optimizeNode()

void optimizeNode	(	Node *	sourceNode,
		Model *	targetModel,
		int	diffuseTextureAtlasSize,
		const map< string, int > &	diffuseTextureAtlasIndices,
		const vector< string > &	excludeDiffuseTextureFileNamePatterns
	)

staticprivate

Prepare for optimization.

Parameters

sourceNode	source node
targetModel	target model
diffuseTextureAtlasSize	diffuse texture atlas size
diffuseTextureAtlasIndices	diffuse texture atlas indices
excludeDiffuseTextureFileNamePatterns	exclude diffuse texture file name patterns

Definition at line 904 of file ModelTools.cpp.

◆ partition()

void partition	(	Model *	model,
		const Transformations &	transformations,
		map< string, Model * > &	modelsByPartition,
		map< string, Vector3 > &	modelsPosition
	)

static

Partition model.

Parameters

model	model
transformations	transformations
modelsByPartition	models by partition
modelsPosition	models position

Definition at line 599 of file ModelTools.cpp.

◆ partitionNode()

void partitionNode	(	Node *	sourceNode,
		map< string, Model * > &	modelsByPartition,
		map< string, Vector3 > &	modelsPosition,
		const Matrix4x4 &	parentTransformationsMatrix
	)

staticprivate

Partition sub nodes.

Parameters

sourceNode	source node to partition
modelsByPartition	models by partition
modelsPosition	models position
parentTransformationsMatrix	parent transformations matrix

Definition at line 367 of file ModelTools.cpp.

◆ prepareForDefaultShader()

void prepareForDefaultShader ( Node * node )

staticprivate

Prepare node for default shader.

Parameters

node node

Definition at line 732 of file ModelTools.cpp.

◆ prepareForFoliageTreeShader()

void prepareForFoliageTreeShader	(	Node *	node,
		const Matrix4x4 &	parentTransformationsMatrix,
		const string &	shader
	)

staticprivate

Prepare node for foliage shader.

Parameters

node	node
parentTransformationsMatrix	parent transformations matrix
shader	shader

Definition at line 740 of file ModelTools.cpp.

◆ prepareForIndexedRendering() [1/3]

void prepareForIndexedRendering ( const map< string, Node * > & nodes )

staticprivate

Prepares this node for indexed rendering.

Parameters

nodes nodes

Definition at line 89 of file ModelTools.cpp.

◆ prepareForIndexedRendering() [2/3]

void prepareForIndexedRendering ( Model * model )

static

Prepare for indexed rendering.

Parameters

model model

Definition at line 84 of file ModelTools.cpp.

◆ prepareForIndexedRendering() [3/3]

void prepareForIndexedRendering	(	Skinning *	skinning,
		const vector< int32_t > &	vertexMapping,
		int32_t	vertices
	)

staticprivate

Maps original vertices to new vertice mapping.

Parameters

skinning	skinning
vertexMapping	vertice mapping / new vertex index to old vertex index
vertices	vertice count

Definition at line 178 of file ModelTools.cpp.

◆ prepareForOptimization()

void prepareForOptimization	(	Node *	node,
		const Matrix4x4 &	parentTransformationsMatrix
	)

staticprivate

Prepare for optimization.

Parameters

node	node
parentTransformationsMatrix	parent transformations matrix
materialUseCount	material use count

Definition at line 854 of file ModelTools.cpp.

◆ prepareForShader()

void prepareForShader	(	Model *	model,
		const string &	shader
	)

static

Prepare model for foliage shader.

Parameters

model	model
shader	shader

Definition at line 717 of file ModelTools.cpp.

◆ prepareForWaterShader()

void prepareForWaterShader	(	Node *	node,
		const Matrix4x4 &	parentTransformationsMatrix
	)

staticprivate

Prepare node for water shader.

Parameters

node	node
parentTransformationsMatrix	parent transformations matrix

Definition at line 785 of file ModelTools.cpp.

◆ setJoint()

void setJoint ( Node * root )

staticprivate

Sets up a node as joint taking all subnodes into account.

Parameters

root node

Definition at line 213 of file ModelTools.cpp.

◆ setupJoints()

void setupJoints ( Model * model )

static

Set up joints for skinning nodes.

Parameters

model model

Definition at line 193 of file ModelTools.cpp.

◆ shrinkToFit() [1/2]

void shrinkToFit ( Model * model )

static

Shrink to fit.

Parameters

model model

Definition at line 638 of file ModelTools.cpp.

◆ shrinkToFit() [2/2]

void shrinkToFit ( Node * node )

staticprivate

Shrink to fit node.

Parameters

node node

Definition at line 617 of file ModelTools.cpp.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/utilities/ModelTools.h
/home/andreas/Development/drewke.net/tdme2/src/tdme/utilities/ModelTools.cpp

Public Types

Static Public Member Functions

Static Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ VertexOrder

Member Function Documentation

◆ checkForOptimization()

◆ cloneMaterial()

◆ cloneNode()

◆ computeNormal()

◆ computeNormals() [1/3]

◆ computeNormals() [2/3]

◆ computeNormals() [3/3]

◆ createAtlasTexture()

◆ createDefaultAnimation()

◆ createTangentsAndBitangents()

◆ determineFaceCount()

◆ determineVertexOrder()

◆ fixAnimationLength() [1/2]

◆ fixAnimationLength() [2/2]

◆ hasDefaultAnimation()

◆ interpolateNormal()

◆ isOptimizedModel()

◆ optimizeModel()

◆ optimizeNode()

◆ partition()

◆ partitionNode()

◆ prepareForDefaultShader()

◆ prepareForFoliageTreeShader()

◆ prepareForIndexedRendering() [1/3]

◆ prepareForIndexedRendering() [2/3]

◆ prepareForIndexedRendering() [3/3]

◆ prepareForOptimization()

◆ prepareForShader()

◆ prepareForWaterShader()

◆ setJoint()

◆ setupJoints()

◆ shrinkToFit() [1/2]

◆ shrinkToFit() [2/2]