HGroup Class Reference

A HGroup is the group itself, rather than the group elements. More...

#include <HCP.h>

Inheritance diagram for HGroup:

[legend]Collaboration diagram for HGroup:

[legend]List of all members.

Public Member Functions
HAttrProperty *	GetAttr ()
HGroupCP *	GetGroupCP ()
	Returns a pointer to the first HGroupCP in this group.
Matrix34 *	GetMatrix ()
	Returns a pointer to the matrix associated with this group.
BOOL	IsTempGroup ()
	Returns TRUE if the group is a temporary group.
void	SetTempGroup (BOOL istemp)
	Sets the temporary status of the group.
BOOL	AddCP (HCP *cp)
	Adds a control point to the group.
BOOL	RemoveCP (HCP *cp)
	Removes the CP from he group.
HDecalClipContainer *	GetChildDecalClipContainer ()
BOOL	IsPatchInGroup (HPatch *patch)
BOOL	IsCPInGroup (HCP *hcp)
	Returns TRUE if the CP is a member of the group.
HDecalClip *	CreateGroupDecal (HClip *clipcache=NULL)
void	RotateGroupImages ()
HPolyModifierShortcut *	GetPolyModifierHead ()

---

Detailed Description

A HGroup is the group itself, rather than the group elements.

A HGroup usually represents a model's named group as it appears in the "Groups" folder under a model in the Project Workspace Tree.

See also:

HGroupCP

Definition at line 143 of file HCP.h.

---

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

---