Representation of a 3d model. More...

#include <tdme/engine/model/Model.h>

Collaboration diagram for Model:

Public Types
enum	AuthoringTool { AUTHORINGTOOL_UNKNOWN , AUTHORINGTOOL_BLENDER }

Public Member Functions
	Model (const string &id, const string &name, UpVector upVector, RotationOrder rotationOrder, BoundingBox *boundingBox, AuthoringTool authoringTool=AUTHORINGTOOL_UNKNOWN)
	Public constructor. More...

	~Model ()
	Deconstructor. More...

AuthoringTool	getAuthoringTool ()

uint32_t	getUniqueId ()

const string &	getId ()

const string &	getName ()

UpVector *	getUpVector ()

void	setUpVector (UpVector *upVector)
	Set up vector. More...

RotationOrder *	getRotationOrder ()

ShaderModel *	getShaderModel ()

void	setShaderModel (ShaderModel *shaderModel)
	Set preferred shader model. More...

map< string, Material * > &	getMaterials ()
	Returns all object materials. More...

map< string, Node * > &	getNodes ()
	Returns all object's nodes. More...

Node *	getNodeById (const string &id)
	Returns a node by given name or null. More...

map< string, Node * > &	getSubNodes ()
	Returns object's sub nodes. More...

Node *	getSubNodeById (const string &id)
	Returns a sub node by given name or null. More...

bool	hasSkinning ()

float	getFPS ()

void	setFPS (float fps)
	Set model animation frames per seconds. More...

AnimationSetup *	addAnimationSetup (const string &id, int32_t startFrame, int32_t endFrame, bool loop, float speed=1.0f)
	Adds an base animation setup. More...

AnimationSetup *	addOverlayAnimationSetup (const string &id, const string &overlayFromNodeId, int32_t startFrame, int32_t endFrame, bool loop, float speed=1.0f)
	Adds an overlay animation setup. More...

AnimationSetup *	getAnimationSetup (const string &id)

bool	removeAnimationSetup (const string &id)
	Remove animation setup. More...

bool	renameAnimationSetup (const string &id, const string &newId)
	Rename animation set up. More...

map< string, AnimationSetup * > &	getAnimationSetups ()
	TODO: return const map. More...

bool	hasAnimations ()

const Matrix4x4 &	getImportTransformationsMatrix ()

void	setImportTransformationsMatrix (const Matrix4x4 &importTransformationsMatrix)
	Set import transformations matrix. More...

BoundingBox *	getBoundingBox ()

void	invalidateBoundingBox ()
	Invalidates bounding box. More...

bool	computeTransformationsMatrix (const string &nodeId, const Matrix4x4 &parentTransformationsMatrix, Matrix4x4 &transformationsMatrix, int32_t frame=0)
	Computes a transformations matrix at a given frame for a given node id recursivly. More...

bool	computeTransformationsMatrix (const string &nodeId, Matrix4x4 &transformationsMatrix, int32_t frame=0)
	Computes a transformations matrix at a given frame for a given node id recursivly. More...

bool	hasBoundingBoxUpdate ()

Static Public Attributes
static STATIC_DLL_IMPEXT string	ANIMATIONSETUP_DEFAULT = "tdme.default"

static STATIC_DLL_IMPEXT constexpr float	FPS_DEFAULT { 30.0f }

static STATIC_DLL_IMPEXT uint32_t	uidCounter = 0

Private Member Functions
void	deleteSubNodes (const map< string, Node * > &subNodes)
	Delete sub nodes. More...

void	setHasSkinning (bool hasSkinning)
	Set up if model has skinning. More...

bool	computeTransformationsMatrix (const map< string, Node * > &nodes, const Matrix4x4 &parentTransformationsMatrix, int32_t frame, const string &nodeId, Matrix4x4 &transformationsMatrix)
	Computes a transformations matrix at a given frame for a given node id recursivly. More...

Private Attributes
AuthoringTool	authoringTool

uint32_t	uniqueId

string	id

string	name

UpVector *	upVector

RotationOrder *	rotationOrder

ShaderModel *	shaderModel

map< string, Material * >	materials

map< string, Node * >	nodes

map< string, Node * >	subNodes

bool	skinning

float	fps

map< string, AnimationSetup * >	animationSetups

Matrix4x4	importTransformationsMatrix

BoundingBox *	boundingBox

bool	boundingBoxUpdated

Friends
class	Node

Detailed Description

Representation of a 3d model.

Author: andreas.drewke

Version: $Id$

Definition at line 31 of file Model.h.

Member Enumeration Documentation

◆ AuthoringTool

enum AuthoringTool

Enumerator
AUTHORINGTOOL_UNKNOWN
AUTHORINGTOOL_BLENDER

Definition at line 36 of file Model.h.

Constructor & Destructor Documentation

◆ Model()

Model	(	const string &	id,
		const string &	name,
		UpVector *	upVector,
		RotationOrder *	rotationOrder,
		BoundingBox *	boundingBox,
		AuthoringTool	authoringTool = `AUTHORINGTOOL_UNKNOWN`
	)

Public constructor.

Parameters

id	id
name	name
upVector	up vector
rotationOrder	rotation order
boundingBox	bounding box
authoringTool	authoring tool

Definition at line 44 of file Model.cpp.

◆ ~Model()

~Model ( )

Deconstructor.

Definition at line 60 of file Model.cpp.

Member Function Documentation

◆ addAnimationSetup()

AnimationSetup * addAnimationSetup	(	const string &	id,
		int32_t	startFrame,
		int32_t	endFrame,
		bool	loop,
		float	speed = `1.0f`
	)

Adds an base animation setup.

Parameters

id	id
startFrame	start frame
endFrame	end frame
loop	loop
speed	speed whereas 1.0 is default speed

Returns: animation setup

Definition at line 97 of file Model.cpp.

◆ addOverlayAnimationSetup()

AnimationSetup * addOverlayAnimationSetup	(	const string &	id,
		const string &	overlayFromNodeId,
		int32_t	startFrame,
		int32_t	endFrame,
		bool	loop,
		float	speed = `1.0f`
	)

Adds an overlay animation setup.

Parameters

id	id
overlayFromNodeId	overlay from node id
startFrame	start frame
endFrame	end frame
loop	loop
speed	speed whereas 1.0 is default speed

Returns: animation setup

Definition at line 109 of file Model.cpp.

◆ computeTransformationsMatrix() [1/3]

bool computeTransformationsMatrix	(	const map< string, Node * > &	nodes,
		const Matrix4x4 &	parentTransformationsMatrix,
		int32_t	frame,
		const string &	nodeId,
		Matrix4x4 &	transformationsMatrix
	)

private

Computes a transformations matrix at a given frame for a given node id recursivly.

Parameters

nodes	nodes
parentTransformationsMatrix	parent transformations matrix
frame	frame
nodeId	node id
transformationsMatrix	transformations matrix

Returns: target node transformations

Definition at line 151 of file Model.cpp.

◆ computeTransformationsMatrix() [2/3]

bool computeTransformationsMatrix	(	const string &	nodeId,
		const Matrix4x4 &	parentTransformationsMatrix,
		Matrix4x4 &	transformationsMatrix,
		int32_t	frame = `0`
	)

inline

Computes a transformations matrix at a given frame for a given node id recursivly.

Parameters

nodeId	node id
parentTransformationsMatrix	parent transformations matrix
transformationsMatrix	target node transformations matrix
frame	frame

Definition at line 322 of file Model.h.

◆ computeTransformationsMatrix() [3/3]

bool computeTransformationsMatrix	(	const string &	nodeId,
		Matrix4x4 &	transformationsMatrix,
		int32_t	frame = `0`
	)

inline

Computes a transformations matrix at a given frame for a given node id recursivly.

Parameters

nodeId	node id
transformationsMatrix	target node transformations matrix
frame	frame

Definition at line 332 of file Model.h.

◆ deleteSubNodes()

void deleteSubNodes ( const map< string, Node * > & subNodes )

private

Delete sub nodes.

Parameters

subNodes sub nodes

Definition at line 71 of file Model.cpp.

◆ getAnimationSetup()

AnimationSetup * getAnimationSetup ( const string & id )

Returns: animation setup for given id or null

Definition at line 116 of file Model.cpp.

◆ getAnimationSetups()

map< string, AnimationSetup * > & getAnimationSetups ( )

inline

TODO: return const map.

Returns: animation setup for given id or null

Definition at line 274 of file Model.h.

◆ getAuthoringTool()

AuthoringTool getAuthoringTool ( )

inline

Returns: authoring tool

Definition at line 105 of file Model.h.

◆ getBoundingBox()

BoundingBox * getBoundingBox ( )

Returns: bounding box

Definition at line 142 of file Model.cpp.

◆ getFPS()

float getFPS ( )

inline

Returns: frames per seconds

Definition at line 215 of file Model.h.

◆ getId()

const string & getId ( )

inline

Returns: model id

Definition at line 119 of file Model.h.

◆ getImportTransformationsMatrix()

const Matrix4x4 & getImportTransformationsMatrix ( )

inline

Returns: import transformations matrix like converting Z-UP to Y-UP

Definition at line 293 of file Model.h.

◆ getMaterials()

map< string, Material * > & getMaterials ( )

inline

Returns all object materials.

Returns: materials

Definition at line 171 of file Model.h.

◆ getName()

const string & getName ( )

inline

Returns: model name

Definition at line 126 of file Model.h.

◆ getNodeById()

Node * getNodeById ( const string & id )

Returns a node by given name or null.

Parameters

id id

Returns

Definition at line 78 of file Model.cpp.

◆ getNodes()

map< string, Node * > & getNodes ( )

inline

Returns all object's nodes.

Returns: all nodes

Definition at line 179 of file Model.h.

◆ getRotationOrder()

RotationOrder * getRotationOrder ( )

inline

Returns: rotation order

Definition at line 148 of file Model.h.

◆ getShaderModel()

ShaderModel * getShaderModel ( )

inline

Returns: preferred shader model

Definition at line 155 of file Model.h.

◆ getSubNodeById()

Node * getSubNodeById ( const string & id )

Returns a sub node by given name or null.

Parameters

id id

Returns

Definition at line 88 of file Model.cpp.

◆ getSubNodes()

map< string, Node * > & getSubNodes ( )

inline

Returns object's sub nodes.

Returns: sub nodes

Definition at line 194 of file Model.h.

◆ getUniqueId()

uint32_t getUniqueId ( )

inline

Returns: unique model id

Definition at line 112 of file Model.h.

◆ getUpVector()

UpVector * getUpVector ( )

inline

Returns: up vector

Definition at line 133 of file Model.h.

◆ hasAnimations()

bool hasAnimations ( )

inline

Returns: if model has animations

Definition at line 281 of file Model.h.

◆ hasBoundingBoxUpdate()

bool hasBoundingBoxUpdate ( )

inline

Returns: if vertices have been updated

Definition at line 339 of file Model.h.

◆ hasSkinning()

bool hasSkinning ( )

inline

Returns: has skinning

Definition at line 208 of file Model.h.

◆ invalidateBoundingBox()

void invalidateBoundingBox ( )

Invalidates bounding box.

Definition at line 184 of file Model.cpp.

◆ removeAnimationSetup()

bool removeAnimationSetup ( const string & id )

Remove animation setup.

Parameters

id id

Returns: success

Definition at line 125 of file Model.cpp.

◆ renameAnimationSetup()

bool renameAnimationSetup	(	const string &	id,
		const string &	newId
	)

Rename animation set up.

Parameters

id	id
newId	new id

Returns: success

Definition at line 132 of file Model.cpp.

◆ setFPS()

void setFPS ( float fps )

inline

Set model animation frames per seconds.

Parameters

fps fps

Definition at line 223 of file Model.h.

◆ setHasSkinning()

void setHasSkinning ( bool hasSkinning )

inlineprivate

Set up if model has skinning.

Parameters

hasSkinning has skinning

Definition at line 70 of file Model.h.

◆ setImportTransformationsMatrix()

void setImportTransformationsMatrix ( const Matrix4x4 & importTransformationsMatrix )

inline

Set import transformations matrix.

Parameters

importTransformationsMatrix import transformations matrix like converting Z-UP to Y-UP

Definition at line 301 of file Model.h.

◆ setShaderModel()

void setShaderModel ( ShaderModel * shaderModel )

inline

Set preferred shader model.

Parameters

shaderModel preferred shader model

Definition at line 163 of file Model.h.

◆ setUpVector()

void setUpVector ( UpVector * upVector )

inline

Set up vector.

Parameters

upVector up vector

Definition at line 141 of file Model.h.

Friends And Related Function Documentation

◆ Node

friend class Node

friend

Definition at line 33 of file Model.h.

Member Data Documentation

◆ ANIMATIONSETUP_DEFAULT

string ANIMATIONSETUP_DEFAULT = "tdme.default"

static

Definition at line 38 of file Model.h.

◆ animationSetups

map<string, AnimationSetup*> animationSetups

private

Definition at line 55 of file Model.h.

◆ authoringTool

AuthoringTool authoringTool

private

Definition at line 43 of file Model.h.

◆ boundingBox

BoundingBox* boundingBox

private

Definition at line 57 of file Model.h.

◆ boundingBoxUpdated

bool boundingBoxUpdated

private

Definition at line 58 of file Model.h.

◆ fps

float fps

private

Definition at line 54 of file Model.h.

◆ FPS_DEFAULT

constexpr float FPS_DEFAULT { 30.0f }

staticconstexpr

Definition at line 39 of file Model.h.

◆ id

string id

private

Definition at line 45 of file Model.h.

◆ importTransformationsMatrix

Matrix4x4 importTransformationsMatrix

private

Definition at line 56 of file Model.h.

◆ materials

map<string, Material*> materials

private

Definition at line 50 of file Model.h.

◆ name

string name

private

Definition at line 46 of file Model.h.

◆ nodes

map<string, Node*> nodes

private

Definition at line 51 of file Model.h.

◆ rotationOrder

RotationOrder* rotationOrder

private

Definition at line 48 of file Model.h.

◆ shaderModel

ShaderModel* shaderModel

private

Definition at line 49 of file Model.h.

◆ skinning

bool skinning

private

Definition at line 53 of file Model.h.

◆ subNodes

map<string, Node*> subNodes

private

Definition at line 52 of file Model.h.

◆ uidCounter

uint32_t uidCounter = 0

static

Definition at line 40 of file Model.h.

◆ uniqueId

uint32_t uniqueId

private

Definition at line 44 of file Model.h.

◆ upVector

UpVector* upVector

private

Definition at line 47 of file Model.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/engine/model/Model.h
/home/andreas/Development/drewke.net/tdme2/src/tdme/engine/model/Model.cpp

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ AuthoringTool

Constructor & Destructor Documentation

◆ Model()

◆ ~Model()

Member Function Documentation

◆ addAnimationSetup()

◆ addOverlayAnimationSetup()

◆ computeTransformationsMatrix() [1/3]

◆ computeTransformationsMatrix() [2/3]

◆ computeTransformationsMatrix() [3/3]

◆ deleteSubNodes()

◆ getAnimationSetup()

◆ getAnimationSetups()

◆ getAuthoringTool()

◆ getBoundingBox()

◆ getFPS()

◆ getId()

◆ getImportTransformationsMatrix()

◆ getMaterials()

◆ getName()

◆ getNodeById()

◆ getNodes()

◆ getRotationOrder()

◆ getShaderModel()

◆ getSubNodeById()

◆ getSubNodes()

◆ getUniqueId()

◆ getUpVector()

◆ hasAnimations()

◆ hasBoundingBoxUpdate()

◆ hasSkinning()

◆ invalidateBoundingBox()

◆ removeAnimationSetup()

◆ renameAnimationSetup()

◆ setFPS()

◆ setHasSkinning()

◆ setImportTransformationsMatrix()

◆ setShaderModel()

◆ setUpVector()

Friends And Related Function Documentation

◆ Node

Member Data Documentation

◆ ANIMATIONSETUP_DEFAULT

◆ animationSetups

◆ authoringTool

◆ boundingBox

◆ boundingBoxUpdated

◆ fps

◆ FPS_DEFAULT

◆ id

◆ importTransformationsMatrix

◆ materials

◆ name

◆ nodes

◆ rotationOrder

◆ shaderModel

◆ skinning

◆ subNodes

◆ uidCounter

◆ uniqueId

◆ upVector