This reference page is linked to from the following overview topics: List of Python FBX classes.
Detailed Description
This constraint class contains methods for accessing the properties of a scale constraint.
A scale constraint lets you constrain the scale of an object based on the scale of one or more sources.
Definition at line 34 of file kfbxconstraintscale.h.
#include <kfbxconstraintscale.h>
Public Member Functions |
|
| void | SetLock (bool pLock) |
| Set the constraint lock. |
|
| bool | GetLock () const |
| Retrieve the constraint lock state. |
|
| void | SetAffectX (bool pAffect) |
| Set the constraint X-axis effectiveness.
|
|
| bool | GetAffectX () const |
| Retrieve the constraint X-axis
effectiveness. |
|
| void | SetAffectY (bool pAffect) |
| Set the constraint Y-axis effectiveness.
|
|
| bool | GetAffectY () const |
| Retrieve the constraint Y-axis
effectiveness. |
|
| void | SetAffectZ (bool pAffect) |
| Set the constraint Z-axis effectiveness.
|
|
| bool | GetAffectZ () const |
| Retrieve the constraint Z-axis
effectiveness. |
|
| virtual void | SetOffset (KFbxVector4 pScale) |
| Set the Scale offset. |
|
| KFbxVector4 | GetOffset () const |
| Retrieve the constraint scale offset.
|
|
| void | SetWeight (double pWeight) |
| Set the weight of the constraint. |
|
| void | AddConstraintSource (KFbxObject *pObject, double pWeight=100) |
| Add a 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 |
|
| KFbxConstraintScale (KFbxSdkManager &pManager, char const *pName) | |
| virtual bool | ConstructProperties (bool pForceSet) |
| virtual EConstraintType | GetConstraintType () const |
| Access the type of the constraint. |
|
Properties |
|
| KFbxTypedProperty< fbxBool1 > | AffectX |
| This property handles whether to affect x
axis. |
|
| KFbxTypedProperty< fbxBool1 > | AffectY |
| This property handles whether to affect y
axis. |
|
| KFbxTypedProperty< fbxBool1 > | AffectZ |
| This property handles whether to affect z
axis. |
|
| KFbxTypedProperty< fbxDouble3 > | Scaling |
| This property handles scaling offset.
|
|
| KFbxTypedProperty< fbxReference > | ConstraintSources |
| This property handles constraint source
objects. |
|
| KFbxTypedProperty< fbxReference > | ConstrainedObject |
| This property handles constraint target
objects. |
|
Constructor & Destructor Documentation
| KFbxConstraintScale | ( | KFbxSdkManager & | pManager, |
| char const * | pName | ||
| ) | [protected] |
Member Function Documentation
| void SetLock | ( | bool | pLock | ) |
| bool GetLock | ( | ) | const |
| void SetAffectX | ( | bool | pAffect | ) |
Set the constraint X-axis effectiveness.
- Parameters:
-
pAffect State of the effectiveness on the X axis.
| bool GetAffectX | ( | ) | const |
Retrieve the constraint X-axis effectiveness.
- Returns:
- Current state flag.
| void SetAffectY | ( | bool | pAffect | ) |
Set the constraint Y-axis effectiveness.
- Parameters:
-
pAffect State of the effectiveness on the X axis.
| bool GetAffectY | ( | ) | const |
Retrieve the constraint Y-axis effectiveness.
- Returns:
- Current state flag.
| void SetAffectZ | ( | bool | pAffect | ) |
Set the constraint Z-axis effectiveness.
- Parameters:
-
pAffect State of the effectiveness on the X axis.
| bool GetAffectZ | ( | ) | const |
Retrieve the constraint Z-axis effectiveness.
- Returns:
- Current state flag.
| virtual void SetOffset | ( | KFbxVector4 | pScale | ) | [virtual] |
| KFbxVector4 GetOffset | ( | ) | const |
| void SetWeight | ( | double | pWeight | ) |
| void AddConstraintSource | ( | KFbxObject * | pObject, |
| double | pWeight =
100 |
||
| ) |
Add a source to the constraint.
- Parameters:
-
pObject New source object. pWeight Weight of the source object.
| int GetConstraintSourceCount | ( | ) | const [virtual] |
Retrieve the constraint source count.
- Returns:
- Current constraint source count.
Reimplemented from KFbxConstraint.
| KFbxObject* GetConstraintSource | ( | int | pIndex | ) | const [virtual] |
Retrieve a constraint source object.
- Parameters:
-
pIndex Index of the source
- Returns:
- Current source at the specified index.
Reimplemented from KFbxConstraint.
| void SetConstrainedObject | ( | KFbxObject * | pObject | ) |
| KFbxObject* GetConstrainedObject | ( | ) | const [virtual] |
Retrieve the constrained object.
- Returns:
- Current constrained object.
Reimplemented from KFbxConstraint.
| virtual bool ConstructProperties | ( | bool | pForceSet | ) | [protected, virtual] |
Reimplemented from KFbxConstraint.
| virtual EConstraintType GetConstraintType | ( | ) | const [protected, virtual] |
Access the type of the constraint.
- Returns:
- This type of the constraint.
Reimplemented from KFbxConstraint.
Member Data Documentation
This property handles whether to affect x axis.
Default value is true.
Definition at line 46 of file kfbxconstraintscale.h.
This property handles whether to affect y axis.
Default value is true.
Definition at line 51 of file kfbxconstraintscale.h.
This property handles whether to affect z axis.
Default value is true.
Definition at line 56 of file kfbxconstraintscale.h.
This property handles scaling offset.
Default value is (0, 0, 0).
Definition at line 61 of file kfbxconstraintscale.h.
This property handles constraint source objects.
Definition at line 65 of file kfbxconstraintscale.h.
This property handles constraint target objects.
Definition at line 69 of file kfbxconstraintscale.h.
The documentation for this class was generated from the following file:
- fbxfilesdk/kfbxplugins/kfbxconstraintscale.h
