This reference page is linked to from the following overview topics: List of Python FBX classes.

Detailed Description

The parent constraint creates a parent-to-child relationship between any two objects, from any two hierarchies.

It creates the same relationship as the parent-to-child relationships found in hierarchies. You can use this constraint to connect objects without changing hierarchies.

Definition at line 58 of file kfbxconstraintparent.h.

#include <kfbxconstraintparent.h>

Inheritance diagram for KFbxConstraintParent:

[legend]

List of all members.

Public Member Functions
void	SetLock (bool pLock)
	Set the constraint lock state.
bool	GetLock () const
	Retrieve the constraint lock state.
void	SetTranslationOffset (KFbxObject *pObject, KFbxVector4 pTranslation)
	Set the translation offset of the specified constraint source.
KFbxVector4	GetTranslationOffset (const KFbxObject *pObject) const
	Retrieve the translation offset of the specified constraint source.
virtual void	SetRotationOffset (const KFbxObject *pObject, KFbxVector4 pRotation)
	Set the rotation offset of the specified constraint source.
KFbxVector4	GetRotationOffset (const KFbxObject *pObject) const
	Retrieve the rotation offset of the specified constraint source.
void	SetWeight (double pWeight)
	Set the weight of the constraint.
void	AddConstraintSource (KFbxObject *pObject, double pWeight=100)
	Add a constraint source to the constraint.
int	GetConstraintSourceCount () const
	Retrieve the constraint source count.
KFbxObject *	GetConstraintSource (int pIndex) const
	Retrieve a constraint source object.
void	SetConstrainedObject (KFbxObject *pObject)
	Set the constrained object.
KFbxObject *	GetConstrainedObject () const
	Retrieve the constrained object.
Protected Member Functions
	KFbxConstraintParent (KFbxSdkManager &pManager, char const *pName)
virtual bool	ConstructProperties (bool pForceSet)
virtual EConstraintType	GetConstraintType () const
	Access the type of the constraint.
Properties
KFbxTypedProperty< fbxBool1 >	AffectTranslationX
	This property handles whether to affect the translation of the constrained object along X axis.
KFbxTypedProperty< fbxBool1 >	AffectTranslationY
	This property handles whether to affect the translation of the constrained object along Y axis.
KFbxTypedProperty< fbxBool1 >	AffectTranslationZ
	This property handles whether to affect the translation of the constrained object along Z axis.
KFbxTypedProperty< fbxBool1 >	AffectRotationX
	This property handles whether to affect the rotation of the constrained object around X axis.
KFbxTypedProperty< fbxBool1 >	AffectRotationY
	This property handles whether to affect the rotation of the constrained object around Y axis.
KFbxTypedProperty< fbxBool1 >	AffectRotationZ
	This property handles whether to affect the rotation of the constrained object around Z axis.
KFbxTypedProperty< fbxBool1 >	AffectScalingX
	This property handles whether to affect the scaling of the constrained object along X axis.
KFbxTypedProperty< fbxBool1 >	AffectScalingY
	This property handles whether to affect the scaling of the constrained object along Y axis.
KFbxTypedProperty< fbxBool1 >	AffectScalingZ
	This property handles whether to affect the scaling of the constrained object along Z axis.
KFbxTypedProperty< fbxReference >	ConstraintSources
	This property used to access constraint sources.
KFbxTypedProperty< fbxReference >	ConstrainedObject
	This property used to access constrained object.

Constructor & Destructor Documentation

KFbxConstraintParent	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		`[protected]`

Member Function Documentation

void SetLock ( bool pLock )

Search for all occurrences

Set the constraint lock state.

Parameters:

pLock The new state of the lock flag.

bool GetLock ( ) const

Search for all occurrences

Retrieve the constraint lock state.

Returns:: The current value of the lock flag.

void SetTranslationOffset	(	KFbxObject *	pObject,
		KFbxVector4	pTranslation
	)

Search for all occurrences

Set the translation offset of the specified constraint source.

Parameters:

pObject	The specified constraint source.
pTranslation	The new offset vector.

KFbxVector4 GetTranslationOffset ( const KFbxObject * pObject ) const

Search for all occurrences

Retrieve the translation offset of the specified constraint source.

Parameters:

pObject The specified constraint source.

Returns:: The current translation offset.

virtual void SetRotationOffset	(	const KFbxObject *	pObject,
		KFbxVector4	pRotation
	)		`[virtual]`

Search for all occurrences

Set the rotation offset of the specified constraint source.

Parameters:

pObject	The specified constraint source.
pRotation	The new offset vector.

KFbxVector4 GetRotationOffset ( const KFbxObject * pObject ) const

Search for all occurrences

Retrieve the rotation offset of the specified constraint source.

Parameters:

pObject The specified constraint source.

Returns:: The current translation offset.

void SetWeight ( double pWeight )

Search for all occurrences

Set the weight of the constraint.

Parameters:

pWeight The new weight value.

void AddConstraintSource	(	KFbxObject *	pObject,
		double	pWeight = `100`
	)

Search for all occurrences

Add a constraint source to the constraint.

Parameters:

pObject	New constraint source.
pWeight	Weight of the constraint source.

int GetConstraintSourceCount ( ) const [virtual]

Search for all occurrences

Retrieve the constraint source count.

Returns:: Current constraint source count.

Reimplemented from KFbxConstraint.

KFbxObject* GetConstraintSource ( int pIndex ) const [virtual]

Search for all occurrences

Retrieve a constraint source object.

Parameters:

pIndex Index of the constraint source.

Returns:: The constraint source at the specified index.

Reimplemented from KFbxConstraint.

void SetConstrainedObject ( KFbxObject * pObject )

Search for all occurrences

Set the constrained object.

Parameters:

pObject The constrained object.

KFbxObject* GetConstrainedObject ( ) const [virtual]

Search for all occurrences

Retrieve the constrained object.

Returns:: Current constrained object.

Reimplemented from KFbxConstraint.

virtual bool ConstructProperties ( bool pForceSet ) [protected, virtual]

Search for all occurrences

Reimplemented from KFbxConstraint.

virtual EConstraintType GetConstraintType ( ) const [protected, virtual]

Search for all occurrences

Access the type of the constraint.

Returns:: This type of the constraint.

Reimplemented from KFbxConstraint.

Member Data Documentation

KFbxTypedProperty<fbxBool1> AffectTranslationX

Search for all occurrences

This property handles whether to affect the translation of the constrained object along X axis.

Default value is true.

Definition at line 71 of file kfbxconstraintparent.h.

KFbxTypedProperty<fbxBool1> AffectTranslationY

Search for all occurrences

This property handles whether to affect the translation of the constrained object along Y axis.

Default value is true.

Definition at line 77 of file kfbxconstraintparent.h.

KFbxTypedProperty<fbxBool1> AffectTranslationZ

Search for all occurrences

This property handles whether to affect the translation of the constrained object along Z axis.

Default value is true.

Definition at line 83 of file kfbxconstraintparent.h.

KFbxTypedProperty<fbxBool1> AffectRotationX

Search for all occurrences

This property handles whether to affect the rotation of the constrained object around X axis.

Default value is true.

Definition at line 89 of file kfbxconstraintparent.h.

KFbxTypedProperty<fbxBool1> AffectRotationY

Search for all occurrences

This property handles whether to affect the rotation of the constrained object around Y axis.

Default value is true.

Definition at line 95 of file kfbxconstraintparent.h.

KFbxTypedProperty<fbxBool1> AffectRotationZ

Search for all occurrences

This property handles whether to affect the rotation of the constrained object around Z axis.

Default value is true.

Definition at line 101 of file kfbxconstraintparent.h.

KFbxTypedProperty<fbxBool1> AffectScalingX

Search for all occurrences

This property handles whether to affect the scaling of the constrained object along X axis.

Default value is true.

Definition at line 107 of file kfbxconstraintparent.h.

KFbxTypedProperty<fbxBool1> AffectScalingY

Search for all occurrences

This property handles whether to affect the scaling of the constrained object along Y axis.

Default value is true.

Definition at line 113 of file kfbxconstraintparent.h.

KFbxTypedProperty<fbxBool1> AffectScalingZ

Search for all occurrences

This property handles whether to affect the scaling of the constrained object along Z axis.

Default value is true.

Definition at line 119 of file kfbxconstraintparent.h.

KFbxTypedProperty<fbxReference> ConstraintSources

Search for all occurrences

This property used to access constraint sources.

A constrained object is an object whose position, orientation, and so on is driven by one or more constraint sources.

Definition at line 124 of file kfbxconstraintparent.h.

KFbxTypedProperty<fbxReference> ConstrainedObject

Search for all occurrences

This property used to access constrained object.

A constrained object is an object whose position, orientation, and so on is driven by one or more constraint sources.

Definition at line 129 of file kfbxconstraintparent.h.

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

fbxfilesdk/kfbxplugins/kfbxconstraintparent.h

KFbxConstraintParent Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Properties

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation