classHGroup 02

Member Function Documentation¶

BOOL HGroup::AddCP

(

HCP *

cp

)

Adds a control point to the group.

Returns TRUE if the CP was added succesfully. It would return FALSE if the CP is already a member of the group.

HDecalClip* HGroup::CreateGroupDecal ( HClip * clipcache = NULL )

HAttrProperty * HGroup::GetAttr

(

)


	Returns a pointer to the group surface properties.

HDecalClipContainer* HGroup::GetChildDecalClipContainer

(

)

HGroupCP * HGroup::GetGroupCP

(

)

Returns a pointer to the first HGroupCP in this group.

Use this function when walking through all of the HCP in a group. Use HGroupCP::GetCP() and HGroupCP::GetNext() to walk down the HGroupCP list.

Matrix34 * HGroup::GetMatrix

(

)

Returns a pointer to the matrix associated with this group.

The matrix contains the position, scale, and orientation of the group's pivot. The group's pivot can be set by the user in the interface, and may be used by the plugin to perform operations on the group.

HPolyModifierShortcut* HGroup::GetPolyModifierHead

(

)

BOOL HGroup::IsCPInGroup

(

HCP *

hcp

)


	Returns TRUE if the CP is a member of the group.

BOOL HGroup::IsPatchInGroup

(

HPatch *

patch

)

BOOL HGroup::IsTempGroup

(

)

Returns TRUE if the group is a temporary group.

A temporary group is probably named "untitled" and is created when the user selects a set of control points in the modeling window. This group will be destroyed as soon as the user un-selects or selects another set of control points. The user will make a group persistent by changing the group name in the PWS. The programmer can do that by calling SetTempGroup().

BOOL HGroup::RemoveCP

(

HCP *

cp

)

Removes the CP from he group.

Returns TRUE if the CP was a member of the group and was removed. Would return FALSE if the CP was not a member of the group.

void HGroup::RotateGroupImages

(

)

void HGroup::SetTempGroup

(

BOOL

istemp

)

Sets the temporary status of the group.

A temporary group will be destroyed as soon as it is not selected even if its name is different than "untitled". If you change a temporary group to persistent, be sure to change its name to a unique name.

Parameters:

istemp

- TRUE sets the group as temporary. FALSE, sets the group as persistent.

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

C:/Program Files/Hash Inc/AM120SDK/Include/SDK/HCP.h
C:/Dox/SDK/Comments/HCP.dox

This A:M SDK v12.0 documentation is maintained by Hash Inc. Please address any comments concerning this documentation to AMReports. If you have any information, knowledge, or documentation to share with the A:M developer community, please post them on the Hash SDK forum.