classHCP 03

Member Function Documentation

HCPWeight* HCP::AddCPWeight (   )

BOOL HCP::AddStackToGroup (  HGroupCP **  gh  )

This function is the same as AddToGroup() except that instead of just adding this HCP, it will add this HCP and all attached HCPs to the group. This is useful when adding control points that were created with the Extrude() function. This function always returns TRUE. Parameters: gh  - (uplink) the address of a pointer to the first HGroupCP in the group you wish to add this control point to.

BOOL HCP::AddToGroup (  HGroupCP **  gh  )

This function first searches the group to make sure this control point isn't already in this group. If it finds that it is, the function returns FALSE. Otherwise, a new HGroupCP is allocated and it is set to point to this HCP and the function returns TRUE. The new HGroupCP is returned in the uplink parameter. Parameters: gh  - (uplink) the address of a pointer to the first HGroupCP in the group you wish to add this control point to.

void HCP::ComputeInBias (  const Vector &  goalit, float &  alpha, float &  gamma, float &  magnitude )

Note: Don't seem to work on endpoints of non-looped splines.

void HCP::ComputeOutBias (  const Vector &  goalot, float &  alpha, float &  gamma, float &  magnitude )

Note: Don't seem to work on endpoints of non-looped splines.

HCPInstance * HCP::CreateCPInstance (   )

	Once you are editing the action with a certain model you need to make a call to CreateCPInstance. CreateCPInstance creates a HCPInstance object for the HCP and returns it. if a HCPInstance object already exists for this HCP, the existing object is returned.

HCPInstance * HCP::GetCPInstance (   )

If a HCPInstance object already exists for this HCP, the existing object is returned. Otherwise, NULL is returned. See also: HCP::CreateCPInstance

HCPWeight* HCP::GetCPWeightHead (   )

HCP * HCP::GetHead (   )

	This function returns a pointer to the first HCP in a stack of attached HCPs. When multiple HCPs are attached, the position is stored in the head HCP. So it is important to use GetPosition() and SetPosition() with the HCP that GetHead() returns when dealing with control points that are attached.

UINT HCP::GetID (   )

float HCP::GetInAlpha (   )

	This function returns the Alpha angle value of the spline as it goes into the HCP from the next HCP.

float HCP::GetInGamma (   )

	This function returns the Gamma angle value of the spline as it goes into the HCP from the next HCP.

float HCP::GetInMagnitude (   )

	This function returns the Magnitude of the spline's curvature as it goes into the HCP from the next HCP.

Vector HCP::GetInTangent (   )