DzPoserIKChain Class Reference
[Basic Objects]

A class that stores the IK chain information for an imported Poser figure. More...

Inheritance diagram for DzPoserIKChain:

List of all members.

Methods
void	addLink (DzNode node, Number weight=1.0f, Number index=-1)
void	clearLinks ()
Boolean	getActive ()
DzNode	getGoal ()
String	getLabel ()
DzNode	getLink (Number index)
Number	getLinkWeight (Number index)
Number	getNumLinks ()
void	removeLink (Number index)
void	setActive (Boolean onOff)
void	setGoal (DzNode node)
void	setLabel (String label)
Boolean	setLinkWeight (Number index, Number weight)
Constructors
	DzPoserIKChain (String name="")

---

Detailed Description

A class that stores the IK chain information for an imported Poser figure.

This class is only meant to be used in conjunction with DzPoserIKChains. It stores all the information from a single "inkyChain" section of a Poser CR2 file.

See also:

DzPoserIKChains

---

Constructor & Destructor Documentation

DzPoserIKChain::DzPoserIKChain

(

String

name = ""

)

Default Constructor

---

Member Function Documentation

void DzPoserIKChain::addLink	(	DzNode	node,
		Number	weight = 1.0f,
		Number	index = -1
	)

Adds a link to the chain, with the given weight and at the given index. If index is less than 0 or greater than the current link count, the link will be appended.

Parameters:

	node	The node to add as a link.
	weight	The weight to use for the added link. This parameter is optional and defaults to 1.0.
	index	The index where the link should be added. This parameter is optional and defaults to -1.

void DzPoserIKChain::clearLinks

(

)

Removes all links from the chain.

Boolean DzPoserIKChain::getActive

(

)

Returns:

Whether or not the IK chain is set to be active by default.

DzNode DzPoserIKChain::getGoal

(

)

Returns:

The goal node of the chain.

String DzPoserIKChain::getLabel

(

)

Returns:

The label for the IK chain.

DzNode DzPoserIKChain::getLink

(

Number

index

)

Parameters:

index

The index of the link to retrieve.

Returns:

The link (as a pointer to a DzNode) at the requested index of the chain. The result will be NULL if the index is out or range.

Number DzPoserIKChain::getLinkWeight

(

Number

index

)

Parameters:

index

The index of the link whose weight will be returned.

Returns:

The weight of the link at the given index.

Number DzPoserIKChain::getNumLinks

(

)

Returns:

The number of links defined in the chain.

void DzPoserIKChain::removeLink

(

Number

index

)

Removes the link at the given index from the chain.

Parameters:

index

The index of the link which should be removed.

void DzPoserIKChain::setActive

(

Boolean

onOff

)

Sets whether or not the IK chain is set to active by default.

Parameters:

onOff

If true, the chain will be set to be active by default, otherwise it will be set to be inactive.

void DzPoserIKChain::setGoal

(

DzNode

node

)

Sets the goal node of the chain.

Parameters:

node

The new goal node.

void DzPoserIKChain::setLabel

(

String

label

)

Sets the label for the IK chain.

Parameters:

label

The label to use for the chain.

Boolean DzPoserIKChain::setLinkWeight	(	Number	index,
		Number	weight
	)

Sets the weight of the link at the given index to the given weight.

Parameters:

	index	The index of the link whose weight should be changed.
	weight	The new weight for the link.

---

Copyright © 2002 - 2009 DAZ 3D, Inc.