DzFaceGroup Class Reference
[Object and Geometry Objects]

A collection of faces. More...

Inheritance diagram for DzFaceGroup:

List of all members.

Methods
void	addPoly (Number polyIdx)
void	addQuad (Number quadIdx)
void	addTri (Number triIdx)
Number	getNumFaces ()
Number	getNumPolys ()
Number	getNumQuads ()
Number	getNumTris ()
DzPolyMesh	getOwner ()
Number	getPoly (Number i)
Number	getQuad (Number i)
Number	getTri (Number i)
void	removeAllFaces ()
Boolean	removePoly (Number polyIdx, Boolean updateIndices=false)
Boolean	removeQuad (Number quadIdx, Boolean updateIndices=false)
Boolean	removeTri (Number triIdx, Boolean updateIndices=false)

---

Detailed Description

A collection of faces.

Represents a list of faces from a geometry that are collected into a group. The group is stored as a list of integers which are indices into the face list of the geometry which this group references.

---

Member Function Documentation

void DzFaceGroup::addPoly

(

Number

polyIdx

)

Adds a general polygon index to this group.

Parameters:

polyIdx

The index of the polygon to add to the group

void DzFaceGroup::addQuad

(

Number

quadIdx

)

Adds a quad index to this group.

Parameters:

quadIdx

The index of the quad to add to the group

void DzFaceGroup::addTri

(

Number

triIdx

)

Adds a triangle index to this group.

Parameters:

triIdx

The index of the triangle to add to the group

Number DzFaceGroup::getNumFaces

(

)

Returns:

The number of faces (tris, quads & polys) this group references

Number DzFaceGroup::getNumPolys

(

)

Returns:

The number of polys this group references

Number DzFaceGroup::getNumQuads

(

)

Returns:

The number of quads this group references

Number DzFaceGroup::getNumTris

(

)

Returns:

The number of triangles this group references

DzPolyMesh DzFaceGroup::getOwner

(

)

Returns:

The geometry that this group references

Number DzFaceGroup::getPoly

(

Number

i

)

Parameters:

i

The poly index to return from the list.

Returns:

The i'th poly index in this group.

Number DzFaceGroup::getQuad

(

Number

i

)

Parameters:

i

The quad index to return from the list.

Returns:

The i'th quad index in this group.

Number DzFaceGroup::getTri

(

Number

i

)

Parameters:

i

The triangle index to return from the list.

Returns:

The i'th triangle index in this group.

void DzFaceGroup::removeAllFaces

(

)

Empties the list of faces referenced by this group (all tris, quads and polys)

Boolean DzFaceGroup::removePoly	(	Number	polyIdx,
		Boolean	updateIndices = false
	)

Removes a polygon index from this group.

Parameters:

	polyIdx	The index of the polygon to remove from the group
	updateIndices	If true, all face indices smaller than the given index are decremented to reflect a deletion of this face from the main face list.

Returns:

true if the face was removed, false if it could not be found.

Boolean DzFaceGroup::removeQuad	(	Number	quadIdx,
		Boolean	updateIndices = false
	)

Removes a quad index from this group.

Parameters:

	quadIdx	The index of the quad to remove from the group
	updateIndices	If true, all face indices smaller than the given index are decremented to reflect a deletion of this face from the main face list.

Returns:

true if the face was removed, false if it could not be found.

Boolean DzFaceGroup::removeTri	(	Number	triIdx,
		Boolean	updateIndices = false
	)

Removes a face index from this group.

Parameters:

	triIdx	The index of the face to remove from the group
	updateIndices	If true, all face indices smaller than the given index are decremented to reflect a deletion of this face from the main face list.

Returns:

true if the face was removed, false if it could not be found.

---

Copyright © 2002 - 2009 DAZ 3D, Inc.