Tgl::Group Class Reference

[AI] Scene graph node for parental transforms/color/material/texture; can hold meshes or other groups. More...

#include <tgl.h>

Inheritance diagram for Tgl::Group:

Collaboration diagram for Tgl::Group:

Public Member Functions
virtual Result	SetTransformation (FloatMatrix4 &)=0
	[AI] Sets the group's transformation matrix. More...
virtual Result	SetColor (float r, float g, float b, float a)=0
	[AI] Sets color (and alpha) for all geometry in the group. More...
virtual Result	SetTexture (const Texture *)=0
	[AI] Sets a texture for the entire group. More...
virtual Result	GetTexture (Texture *&)=0
	[AI] Gets the group's texture (if any). More...
virtual Result	SetMaterialMode (MaterialMode)=0
	[AI] Sets material mode for the group (e.g., inherit vs. More...
virtual Result	Add (const Group *)=0
	[AI] Adds a child group to this group. More...
virtual Result	Add (const MeshBuilder *)=0
	[AI] Adds a mesh builder's mesh to the group. More...
virtual Result	Remove (const Group *)=0
	[AI] Removes a child group from this group. More...
virtual Result	Remove (const MeshBuilder *)=0
	[AI] Removes a mesh builder's mesh from group. More...
virtual Result	RemoveAll ()=0
	[AI] Removes all children and meshes from the group. More...
virtual Result	Bounds (D3DVECTOR *, D3DVECTOR *)=0
	[AI] Computes an axis-aligned bounding box for the group in world space. More...
Public Member Functions inherited from Tgl::Object
virtual	~Object ()
	[AI] Destructor; releases resources. More...
virtual void *	ImplementationDataPtr ()=0
	[AI] Returns a pointer to internal/implementation data, if any. More...

Detailed Description

[AI] Scene graph node for parental transforms/color/material/texture; can hold meshes or other groups.

[AI]

[AI] Provides hierarchical operations and bounds calculation for a group and its children. [AI]

Definition at line 669 of file tgl.h.

Member Function Documentation

Add() [1/2]

virtual Result Tgl::Group::Add ( const Group *  )

pure virtual

[AI] Adds a child group to this group.

[AI]

Parameters

group

Group to add. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::GroupImpl.

Add() [2/2]

virtual Result Tgl::Group::Add ( const MeshBuilder *  )

pure virtual

[AI] Adds a mesh builder's mesh to the group.

[AI]

Parameters

builder

Mesh builder providing mesh. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::GroupImpl.

Bounds()

virtual Result Tgl::Group::Bounds ( D3DVECTOR *  , D3DVECTOR *    )

pure virtual

[AI] Computes an axis-aligned bounding box for the group in world space.

[AI]

Parameters

pMin	Output min corner. [AI]
pMax	Output max corner. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::GroupImpl.

GetTexture()

virtual Result Tgl::Group::GetTexture ( Texture *&  )

pure virtual

[AI] Gets the group's texture (if any).

[AI]

Parameters

pTexture

Output pointer to texture. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::GroupImpl.

Remove() [1/2]

virtual Result Tgl::Group::Remove ( const Group *  )

pure virtual

[AI] Removes a child group from this group.

[AI]

Parameters

group

Group to remove. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::GroupImpl.

Remove() [2/2]

virtual Result Tgl::Group::Remove ( const MeshBuilder *  )

pure virtual

[AI] Removes a mesh builder's mesh from group.

[AI]

Parameters

builder

Mesh builder providing mesh. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::GroupImpl.

RemoveAll()

virtual Result Tgl::Group::RemoveAll ( )

pure virtual

[AI] Removes all children and meshes from the group.

[AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::GroupImpl.

SetColor()

virtual Result Tgl::Group::SetColor ( float  r, float  g, float  b, float  a  )

pure virtual

[AI] Sets color (and alpha) for all geometry in the group.

[AI]

Parameters

r	Red. [AI]
g	Green. [AI]
b	Blue. [AI]
a	Alpha. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::GroupImpl.

SetMaterialMode()

virtual Result Tgl::Group::SetMaterialMode ( MaterialMode  )

pure virtual

[AI] Sets material mode for the group (e.g., inherit vs.

explicit). [AI]

Parameters

mode	Material mode. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::GroupImpl.

SetTexture()

virtual Result Tgl::Group::SetTexture ( const Texture *  )

pure virtual

[AI] Sets a texture for the entire group.

[AI]

Parameters

pTexture

Texture object. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::GroupImpl.

SetTransformation()

virtual Result Tgl::Group::SetTransformation ( FloatMatrix4 &  )

pure virtual

[AI] Sets the group's transformation matrix.

[AI]

Parameters

mat	Transformation. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::GroupImpl.

---

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

• tgl.h