FBCharacterSolver Class Reference
FBCharacterSolver Class Reference
Related help topics: #include <mobu-python-api.h>
Class Description
Constraint class.
Inheritance diagram for FBCharacterSolver:
Public Member Functions | |
| __reduce__ () | |
| FBVector3d | GetParentRotationOffset (FBCharacterSolver arg1, FBModel arg2) |
| Get the Parent Rotation Offset of the Given Extra Bone Index. More... | |
| __init__ (object arg1, str arg2, FBCharacter arg3, str arg4) | |
| Constructor. More... | |
| list | GetTransformationOffset (FBCharacterSolver arg1, FBModel arg2) |
| SetTransformationOffset (FBCharacterSolver arg1, FBModel arg2, FBVector3d arg3, FBVector3d arg4, FBVector3d arg5) | |
| SetParentRotationOffset (FBCharacterSolver arg1, FBModel arg2, FBVector3d arg3) | |
| Set the Parent Rotation Offset of the Given Extra Bone Index. More... | |
| object | GetTarget (FBCharacterSolver arg1) |
| method | staticmethod (function) |
| Public Member Functions inherited from FBConstraint | |
| __reduce__ () | |
| object | AnimationNodeInCreate (FBConstraint arg1, object arg2, FBModel arg3, str arg4) |
| object | __copy__ (FBConstraint arg1) |
| object | AnimationNodeOutCreate (FBConstraint arg1, object arg2, FBModel arg3, str arg4) |
| Animation Node Creations (IN/OUT). More... | |
| object | Clone (FBConstraint arg1) |
| Clone the constraint. More... | |
| bool | DeformerBind (FBConstraint arg1, FBModel arg2) |
| Bind/Unbind pModel to deformation constraint. More... | |
| bool | DeformerUnBind (FBConstraint arg1, FBModel arg2) |
| bool | Disable (FBConstraint arg1, FBModel arg2) |
| Disable constraint on pModel. More... | |
| FreezeSRT (FBConstraint arg1, FBModel arg2, object arg3, object arg4, object arg5) | |
| Freeze current model state. More... | |
| FreezeSuggested (FBConstraint arg1) | |
| Suggest 'freeze'. More... | |
| bool | ReferenceAdd (FBConstraint arg1, object arg2, FBModel arg3) |
| Add a reference to a specified group. More... | |
| object | ReferenceGet (FBConstraint arg1, object arg2, object arg3) |
| Get a reference. More... | |
| int | ReferenceGetCount (FBConstraint arg1, object arg2) |
| Get number of references in a specified group. More... | |
| int | ReferenceGroupAdd (FBConstraint arg1, str arg2, object arg3) |
| Add a group of references. More... | |
| int | ReferenceGroupGetCount (FBConstraint arg1) |
| Return the number of reference groups. More... | |
| int | ReferenceGroupGetMaxCount (FBConstraint arg1, object arg2) |
| Get the maximum number of items that can exist in the reference group in question. More... | |
| str | ReferenceGroupGetName (FBConstraint arg1, object arg2) |
| Get the name of the reference group. More... | |
| bool | ReferenceRemove (FBConstraint arg1, object arg2, FBModel arg3) |
| Remove a reference to pModel from the group at pGroupIndex. More... | |
| RemoveAllAnimationNodes (FBConstraint arg1) | |
| Remove animation nodes. More... | |
| RestoreModelState (FBConstraint arg1, FBModel arg2) | |
| Restore the saved model state onto pModel. More... | |
| SaveModelState (FBConstraint arg1, FBModel arg2, object arg3, object arg4, object arg5) | |
| Save current state of pModel. More... | |
| SetupAllAnimationNodes (FBConstraint arg1) | |
| Setup animation nodes. More... | |
| Snap (FBConstraint arg1) | |
| Function Property: Snap constraint. More... | |
| SnapSuggested (FBConstraint arg1) | |
| Suggest 'snap'. More... | |
| __init__ (...) | |
| Constructor. More... | |
| Public Member Functions inherited from FBBox | |
| __reduce__ () | |
| bool | AnimationNodeDestroy (FBBox arg1, FBAnimationNode arg2) |
| Destroy an animation node. More... | |
| __init__ (object arg1, str arg2) | |
| Constructor. More... | |
| object | AnimationNodeInGet (FBBox arg1) |
| Get the (IN/OUT) animation node for this box. More... | |
| bool | AnimationNodeIsUserData (FBBox arg1, FBAnimationNode arg2) |
| Is the animation node user data? More... | |
| object | AnimationNodeOutGet (FBBox arg1) |
| int | GetOutConnectorCount (FBBox arg1) |
| Get the number of animation node outputs for this box. More... | |
| int | GetInConnectorCount (FBBox arg1) |
| Get the number of animation node inputs for this box. More... | |
| object | GetOutConnector (FBBox arg1, object arg2) |
| Get the animation node output associated with the given index. More... | |
| object | GetInConnector (FBBox arg1, object arg2) |
| Get the animation node input associated with the given index. More... | |
| Public Member Functions inherited from FBComponent | |
| __reduce__ () | |
| FBPropertyList | PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2) |
| Get list of properties which have been modified since last loading. More... | |
| str | ClassName (FBComponent arg1) |
| Get the class name. More... | |
| DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2) | |
| Disable a specific Object Flags. More... | |
| EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2) | |
| Enable a specific Object Flags. More... | |
| bool | FBCreate (FBComponent arg1) |
| Open Reality Creation function. More... | |
| FBDelete (FBComponent arg1) | |
| Open Reality deletion function. More... | |
| FBDestroy (FBComponent arg1) | |
| Open Reality destruction function. More... | |
| FBObjectFlag | GetObjectFlags (FBComponent arg1) |
| Get all Object Flags (concatenated). More... | |
| bool | GetObjectStatus (FBComponent arg1, FBObjectStatus arg2) |
| Check to see if an object status is enabled. More... | |
| bool | HasObjectFlags (FBComponent arg1, FBObjectFlag arg2) |
| Check whether a specific object flag is enabled. More... | |
| bool | Is (FBComponent arg1, object arg2) |
| Returns true if object is of type TypeId. More... | |
| bool | ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5) |
| ProcessNamespaceHierarchy. More... | |
| bool | ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5) |
| ProcessObjectNamespace. More... | |
| int | PropertyAdd (FBComponent arg1, FBProperty arg2) |
| Add a property to the component's property manager. More... | |
| bool | PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2) |
| Add a reference property to the component's property manager. More... | |
| object | PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7) |
| Create user or dynamic property. More... | |
| PropertyRemove (FBComponent arg1, FBProperty arg2) | |
| Remove a Property from the component's Property manager. More... | |
| SetObjectFlags (FBComponent arg1, FBObjectFlag arg2) | |
| SetObjectFlags. More... | |
| SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3) | |
| Enable/Disable a specific Object Status. More... | |
| HardSelect (FBComponent arg1) | |
| HardSelect. More... | |
| object | GetOwnerFileReference (FBComponent arg1) |
| Get the owner FileReference object. More... | |
| __init__ (...) | |
| Constructor. More... | |
| Public Member Functions inherited from FBPlug | |
| __reduce__ () | |
| bool | BeginChange (FBPlug arg1) |
| Begins a change on multiple plugs. More... | |
| str | ClassName (FBPlug arg1) |
| internal System vars. More... | |
| bool | ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3) |
| Add a destination connection. More... | |
| bool | ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4) |
| Add a destination connection. More... | |
| bool | ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3) |
| Add a source connection. More... | |
| bool | ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4) |
| Add a source connection. More... | |
| DisconnectAllDst (FBPlug arg1) | |
| Remove all destination connections. More... | |
| DisconnectAllSrc (FBPlug arg1) | |
| Remove all source connections. More... | |
| bool | DisconnectDst (FBPlug arg1, FBPlug arg2) |
| Remove a destination connection. More... | |
| bool | DisconnectDstAt (FBPlug arg1, object arg2) |
| Remove a destination connection at a specified index. More... | |
| bool | DisconnectSrc (FBPlug arg1, FBPlug arg2) |
| Remove a source connection. More... | |
| bool | DisconnectSrcAt (FBPlug arg1, object arg2) |
| Remove a source connection at a specified index. More... | |
| EndChange (FBPlug arg1) | |
| Ends a change on multiple plugs. More... | |
| object | GetDst (FBPlug arg1, object arg2) |
| Get a destination connection's plug at specified index. More... | |
| int | GetDstCount (FBPlug arg1) |
| Get destination connection count. More... | |
| FBConnectionType | GetDstType (FBPlug arg1, object arg2) |
| Get a destination connection's type at specified index. More... | |
| object | GetOwned (FBPlug arg1, object arg2) |
| Get the owned plug at specified index. More... | |
| int | GetOwnedCount (FBPlug arg1) |
| Get the owned plug count. More... | |
| object | GetOwner (FBPlug arg1) |
| Get the owner of this plug. More... | |
| object | GetSrc (FBPlug arg1, object arg2) |
| Get a source connection's plug at specified index. More... | |
| int | GetSrcCount (FBPlug arg1) |
| Get source connection count. More... | |
| FBConnectionType | GetSrcType (FBPlug arg1, object arg2) |
| Get a source connection's type at specified index. More... | |
| bool | Is (FBPlug arg1, object arg2) |
| Is( int pTypeId ) More... | |
| bool | IsSDKComponent (FBPlug arg1) |
| Return whether or not item is an SDK component. More... | |
| MoveSrcAt (...) | |
| bool | ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3) |
| Replace a destination connection at a specified index. More... | |
| bool | ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3) |
| Replace a source connection at a specified index. More... | |
| bool | SwapSrc (FBPlug arg1, object arg2, object arg3) |
| Swap source connection at index A with source connection at index B. More... | |
| SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3) | |
| Set the plug's self modification flag. More... | |
| bool | GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2) |
| Tell if the plug's self has changed. More... | |
| SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3) | |
| Set the plug's owned property/object's modification flag. More... | |
| bool | GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2) |
| Tell if the plug's content has changed. More... | |
| int | GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4) |
| Get plug's modified src/dst property/object connection added/removed List. More... | |
| bool | RevertModification (FBPlug arg1, FBPlugModificationFlag arg2) |
| Revert the plug's modification to original status. More... | |
| __init__ (...) | |
| method | staticmethod (function) |
| Public Member Functions inherited from FBPythonWrapper | |
| __reduce__ () | |
| __init__ (...) | |
Public Attributes | |
| FBPropertyComponent | Source |
| Read Write Property: Source character when doing a character retarget. More... | |
| object | ExtraFK |
| object | ExtraBones |
| Public Attributes inherited from FBConstraint | |
| FBPropertyBool | Active |
| Read Write Property: Active state. More... | |
| FBPropertyBool | Deformer |
| Read Write Property: Is a deformer constraint? More... | |
| ORSDK2018::FBPropertyString | Description |
| Read Write Property: Long description of constraint. More... | |
| FBPropertyBool | HasLayout |
| Read Write Property: Does the constraint have a layout? More... | |
| FBPropertyBool | Lock |
| Read Write Property: Lock state. More... | |
| FBPropertyAnimatableDouble | Weight |
| Read Write Property: Weight of constraint. More... | |
| Public Attributes inherited from FBBox | |
| FBPropertyBool | Animatable |
| Read Write Property: Is the box animatable. More... | |
| FBPropertyBool | Live |
| Read Write Property: Is live? More... | |
| FBPropertyBool | RecordMode |
| Read Write Property: Is recording? More... | |
| const char * | UniqueName |
| internal Unique name. More... | |
| Public Attributes inherited from FBComponent | |
| object | OwnerNamespace |
| ORSDK2018::FBPropertyListComponent | Components |
| List: List of components. More... | |
| ORSDK2018::FBPropertyString | Name |
| Read Write Property: Unique name of object. More... | |
| ORSDK2018::FBPropertyString | LongName |
| Read Write Property: Name and namespace for object. More... | |
| object | FullName |
| ORSDK2018::FBPropertyListComponent | Parents |
| List: Parents. More... | |
| ORSDK2018::FBPropertyManager | PropertyList |
| Read Only Property: Manages all of the properties for the component. More... | |
| FBPropertyBool | Selected |
| Read Write Property: Selected property. More... | |
| Public Attributes inherited from FBPythonWrapper | |
| object | OnUnbind |
Member Function Documentation
| __init__ | ( | object | arg1, |
| str | arg2, | ||
| FBCharacter | arg3, | ||
| str | arg4 | ||
| ) |
Constructor.
Python Docstring:
__init__( (object)arg1, (str)arg2, (FBCharacter)arg3, (str)arg4) -> None
C++ Signature:
FBCharacterSolver(const char * pName, HIObject pObject = ((void *) 0))
- Parameters
-
pName Name of constraint. pObject For internal use only (default is NULL).
| __reduce__ | ( | ) |
| FBVector3d GetParentRotationOffset | ( | FBCharacterSolver | arg1, |
| FBModel | arg2 | ||
| ) |
Get the Parent Rotation Offset of the Given Extra Bone Index.
Python Docstring:
GetParentRotationOffset( (FBCharacterSolver)arg1, (FBModel)arg2) -> FBVector3d
C++ Signature:
void GetParentRotationOffset(FBRVector & pR, int pIndex)
The rotation Offset if extracted at Characterisation (in Stance Pose). You don't need this value if the parent of the bone is characterized too.
- Parameters
-
pR Offset Rotation between the Bone and is parent at Stance Pose. pIndex Index of extra Bone to get.
| object GetTarget | ( | FBCharacterSolver | arg1 | ) |
Python Docstring:
GetTarget( (FBCharacterSolver)arg1) -> object
| list GetTransformationOffset | ( | FBCharacterSolver | arg1, |
| FBModel | arg2 | ||
| ) |
Python Docstring:
GetTransformationOffset( (FBCharacterSolver)arg1, (FBModel)arg2) -> list
| SetParentRotationOffset | ( | FBCharacterSolver | arg1, |
| FBModel | arg2, | ||
| FBVector3d | arg3 | ||
| ) |
Set the Parent Rotation Offset of the Given Extra Bone Index.
Python Docstring:
SetParentRotationOffset( (FBCharacterSolver)arg1, (FBModel)arg2, (FBVector3d)arg3) -> None
C++ Signature:
void SetParentRotationOffset(FBRVector & pR, int pIndex)
The rotation Offset if extracted at Characterisation (in Stance Pose). You don't need this value if the parent of the bone is characterized too.
- Parameters
-
pR Offset Rotation between the Bone and is parent at Stance Pose. pIndex Index of extra Bone to get.
| SetTransformationOffset | ( | FBCharacterSolver | arg1, |
| FBModel | arg2, | ||
| FBVector3d | arg3, | ||
| FBVector3d | arg4, | ||
| FBVector3d | arg5 | ||
| ) |
Python Docstring:
SetTransformationOffset( (FBCharacterSolver)arg1, (FBModel)arg2, (FBVector3d)arg3, (FBVector3d)arg4, (FBVector3d)arg5) -> None
| method staticmethod | ( | function | ) |
Python Docstring:
staticmethod(function) -> method
Convert a function to be a static method.
A static method does not receive an implicit first argument.
To declare a static method, use this idiom:
class C:
def f(arg1, arg2, ...): ...
f = staticmethod(f)
It can be called either on the class (e.g. C.f()) or on an instance
(e.g. C().f()). The instance is ignored except for its class.
Static methods in Python are similar to those found in Java or C++.
For a more advanced concept, see the classmethod builtin.
Member Data Documentation
| ExtraBones |
Read Property: (list) List of Extra Bones in character
| ExtraFK |
Read Property: (list) List of Extra FK in character
| FBPropertyComponent Source |
Read Write Property: Source character when doing a character retarget.