|
Python Reference Guide
|
|
|
Python Reference Guide
|
|
Cube model class. More...
Public Member Functions | |
| FBModelCube (str pName) | |
| Constructor. More... | |
 Public Member Functions inherited from FBModel | |
| FBModel (str pName) | |
| Constructor. More... | |
| FBModel | Clone () |
| Clone the model. More... | |
| CollapseInSchematic () | |
| Collapse the model in the schematic view. More... | |
| DofToLRM (FBMatrix pLM, FBRVector pDof) | |
| Convert object space vector to local matrix. More... | |
| ExpandInSchematic () | |
| Expand the model in the schematic view. More... | |
| FBDelete () | |
| Open Reality deletion function. More... | |
| str | FbxGetObjectSubType () |
| Returns the class sub type inherited by the class of an object, for example: 'Default', 'Mesh'. More... | |
| str | FbxGetObjectType () |
| Returns the class type inherited by the class of an object, for example: 'Model'. More... | |
| ForceAlwaysEvaluate () | |
| Force Always Evaluate. More... | |
| FBColor | GetAdditionalUniqueColorID (unsigned int pIndex) |
| Get Additional Unique Color Id. More... | |
| unsigned int | GetAdditionalUniqueColorIDCount () |
| Get additional unique color count. More... | |
| GetBoundingBox (FBVector3d pMin, FBVector3d pMax) | |
| Get the bounding box of the model. More... | |
| unsigned int | GetHierarchyWorldMatrices (FBMatrix pMatricesArray, unsigned int pMatricesArrayCount, FBModelHiercharyTraverserType pHiercharyTraverserType, FBEvaluateInfo pEvaluateInfo=None) |
| Computes the global transform matrices between this model and all its children (all levels). More... | |
| GetLocalTransformationMatrixWithGlobalRotationDoF (FBMatrix pMatrix, bool pInverse=False, FBEvaluateInfo pEvaluateInfo=None) | |
| Get the local transformation (or local inverse transformation) matrix with the global Rotation DoF values from the model. More... | |
| GetMatrix (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=True, FBEvaluateInfo pEvaluateInfo=None) | |
| Get a matrix from the model. More... | |
| FBVector2d | GetSchematicPosition () |
| Get the position in the schematic view for the model. More... | |
| int | GetSelectedPointsCount () |
| Get the number of selected points in the model. More... | |
| GetVector (FBVector3d pVector, FBModelTransformationType pWhat=kModelTranslation, bool pGlobalInfo=True, FBEvaluateInfo pEvaluateInfo=None) | |
| Get a vector from the model. More... | |
| bool | IsCollapsedInSchematic () |
| Returns if the model is collapsed or not (expanded) in the schematic view. More... | |
| bool | IsEvaluationReady (FBModelEvaluationTaskType pWhat, FBEvaluateInfo pEvaluateInfo=None) |
| Is the model's evaluation task result ready. More... | |
| bool | IsForceAlwaysEvaluate () |
| Return Force Always Evaluate status. More... | |
| bool | IsVisible (FBEvaluateInfo pEvaluateInfo=None) |
| If the model is visible. More... | |
| LRMToDof (FBRVector pDof, FBMatrix pLM) | |
| Convert local matrix to object space vector. More... | |
| MatrixToRotation (FBRVector pRotation, FBMatrix pMatrix) | |
| Convert Rotation Matrix to Euler Vector based on model's rotation order. More... | |
| int | NoFrustumCullingRelease () |
| Release no frustum culling request. More... | |
| int | NoFrustumCullingRequire () |
| Acquire no frustum culling request. More... | |
| bool | RayCast (FBCamera pCamera, int pMouseX, int pMouseY, FBVector3d pHitPosition, FBVector3d pHitNormal) |
| Ray cast test. More... | |
| RotationToMatrix (FBMatrix pMatrix, FBRVector pRotation) | |
| Convert Euler Vector to Rotation Matrix based on model's rotation order. More... | |
| bool | SetAdditionalUniqueColorIDCount (unsigned int pCount) |
| Request additional Unique color IDs. More... | |
| SetMatrix (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=True, bool pPushUndo=False, FBEvaluateInfo pEvaluateInfo=None) | |
| Set a matrix for the model. More... | |
| SetMatrixWithPrecision (FBMatrix pMatrix, FBModelTransformationType pWhat=kModelTransformation, bool pGlobalInfo=True, bool pPushUndo=False, FBEvaluateInfo pEvaluateInfo=None, float pPrecision=FBMat2EulerDegenerateForPrecision10) | |
| Set a matrix for the model. More... | |
| SetSchematicPosition (int pX, int pY) | |
| Set the position in the schematic view for the model. More... | |
| SetSchematicPosition (FBVector2d pVector2d) | |
| Set the position in the schematic view for the model. More... | |
| SetVector (FBVector3d pVector, FBModelTransformationType pWhat=kModelTranslation, bool pGlobalInfo=True, bool pPushUndo=False, FBEvaluateInfo pEvaluateInfo=None) | |
| Set a vector for the model. More... | |
| SetupPropertiesForShapes () | |
| Setup Shape Properties. More... | |
| bool | UseFrustumCulling () |
| Get the current Frustum Culling Status. More... | |
| Public Member Functions inherited from FBBox | |
| FBBox (str pName) | |
| Constructor. More... | |
| bool | AnimationNodeDestroy (FBAnimationNode pAnimationNode) |
| Destroy an animation node. More... | |
| FBAnimationNode | AnimationNodeInGet () |
| Get the (IN/OUT) animation node for this box. More... | |
| bool | AnimationNodeIsUserData (FBAnimationNode pAnimationNode) |
| Is the animation node user data? More... | |
| FBAnimationNode | AnimationNodeOutGet () |
| FBAnimationNode | GetInConnector (int pIndex) |
| Get the animation node input associated with the given index. More... | |
| int | GetInConnectorCount () |
| Get the number of animation node inputs for this box. More... | |
| FBAnimationNode | GetOutConnector (int pIndex) |
| Get the animation node output associated with the given index. More... | |
| int | GetOutConnectorCount () |
| Get the number of animation node outputs for this box. More... | |
| Public Member Functions inherited from FBComponent | |
| FBComponent () | |
| Constructor. More... | |
| str | ClassName () |
| Get the class name. More... | |
| DisableObjectFlags (FBObjectFlag pFlags) | |
| Disable a specific Object Flags. More... | |
| EnableObjectFlags (FBObjectFlag pFlags) | |
| Enable a specific Object Flags. More... | |
| bool | FBCreate () |
| Open Reality Creation function. More... | |
| FBDelete () | |
| Open Reality deletion function. More... | |
| FBDestroy () | |
| Open Reality destruction function. More... | |
| FBObjectFlag | GetObjectFlags () |
| Get all Object Flags (concatenated). More... | |
| bool | GetObjectStatus (FBObjectStatus pStatus) |
| Check to see if an object status is enabled. More... | |
| FBFileReference | GetOwnerFileReference (p0) |
| Get the owner FileReference object. More... | |
| HardSelect () | |
| HardSelect. More... | |
| bool | HasObjectFlags (FBObjectFlag pFlags) |
| Check whether a specific object flag is enabled. More... | |
| bool | Is (int pTypeId) |
| Returns true if object is of type TypeId. More... | |
| bool | ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
| ProcessNamespaceHierarchy. More... | |
| bool | ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
| ProcessObjectNamespace. More... | |
| int | PropertyAdd (FBProperty pProperty) |
| Add a property to the component's property manager. More... | |
| bool | PropertyAddReferenceProperty (FBProperty pReferenceProperty) |
| Add a reference property to the component's property manager. More... | |
| FBProperty | PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None) |
| Create user or dynamic property. More... | |
| PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags) | |
| Get list of properties which have been modified since last loading. More... | |
| PropertyRemove (FBProperty pProperty) | |
| Remove a Property from the component's Property manager. More... | |
| SetObjectFlags (FBObjectFlag pFlags) | |
| SetObjectFlags. More... | |
| SetObjectStatus (FBObjectStatus pStatus, bool pValue) | |
| Enable/Disable a specific Object Status. More... | |
Additional Inherited Members | |
| Public Attributes inherited from FBModel | |
| FBAnimationNode | AnimationNode |
| Read Only Property: Animation node of the model. More... | |
| bool | BlendShapeDeformable |
| Read Write Property: Model blend-shape deformable. Not Savable More... | |
| bool | CastsShadows |
| Read Write Property: If true, the geometry will produce shadows. More... | |
| FBListModel | Children |
| List: Children for model. More... | |
| bool | ConstrainDeformable |
| Read Write Property: Model constraint deformable. Not Savable More... | |
| FBListDeformer | Deformers |
| List: Deformers (Skeleton Deformer or Point Cache Deformer). More... | |
| FBVector3d | GeometricRotation |
| Read Write Property: Geometric rotation. More... | |
| FBVector3d | GeometricScaling |
| Read Write Property: Geometric scaling. More... | |
| FBVector3d | GeometricTranslation |
| Read Write Property: Geometric translation. More... | |
| FBGeometry | Geometry |
| Read Write Property: Geometry for the model. More... | |
| int | GeometryUpdateId |
| Read Only Property: model geometry (vertex data) related update id. More... | |
| bool | Icon3D |
| Read Write Property: Is model a 3D icon? More... | |
| bool | IsConstrained |
| Read Only Property: Is model constrained? More... | |
| bool | IsDeformable |
| Read Only Property: Is model deformable? More... | |
| FBModel | LookAt |
| Read Write Property: Look at model (interest point). More... | |
| FBListMaterial | Materials |
| List: Materials for model. More... | |
| FBModelVertexData | ModelVertexData |
| Read Only Property: ModelVertexData for the model. More... | |
| FBModel | Parent |
| Read Write Property: Parent model. More... | |
| bool | Pickable |
| Read Write Property: Indicate if a model can be picked in the viewer. This has a default value of 'true'. More... | |
| bool | PointCacheDeformable |
| Read Write Property: Model point cache deformable. Not Savable More... | |
| bool | PointCacheRecord |
| Read Write Property: Record Point Cache for model? Not Savable More... | |
| FBVector3d | PostRotation |
| Read Write Property: Post Rotation (considered if RotationActive is true) More... | |
| FBVector3d | PreRotation |
| Read Write Property: Pre Rotation (considered if RotationActive is true) More... | |
| bool | PrimaryVisibility |
| Read Write Property: Control the geometry render state. Geometry can still cast shadows even if this is turned off. More... | |
| bool | QuaternionInterpolate |
| Read Write Property: Use quaternion interpolation. More... | |
| bool | ReceiveShadows |
| Read Write Property: If true, the geometry will receive shadows. More... | |
| FBAnimatableVector3d | Rotation |
| Read Write Property: Lcl rotation. More... | |
| bool | RotationActive |
| Read Write Property: Is model using Rotation Limits? More... | |
| FBVector3d | RotationMax |
| Read Write Property: Max Rotation Limit (considered if RotationActive is true) More... | |
| bool | RotationMaxX |
| Read Write Property: Is model using Maximum Rotation Limits On X? More... | |
| bool | RotationMaxY |
| Read Write Property: Is model using Maximum Rotation Limits On Y? More... | |
| bool | RotationMaxZ |
| Read Write Property: Is model using Maximum Rotation Limits On Z? More... | |
| FBVector3d | RotationMin |
| Read Write Property: Min Rotation Limit (considered if RotationActive is true) More... | |
| bool | RotationMinX |
| Read Write Property: Is model using Minimum Rotation Limits On X? More... | |
| bool | RotationMinY |
| Read Write Property: Is model using Minimum Rotation Limits On Y? More... | |
| bool | RotationMinZ |
| Read Write Property: Is model using Minimum Rotation Limits On Z? More... | |
| FBModelRotationOrder | RotationOrder |
| Read Write Property: Rotation order. More... | |
| bool | RotationSpaceForLimitOnly |
| Read Write Property: Apply Post Rotation Matrix only for Limits? More... | |
| FBAnimatableVector3d | Scaling |
| Read Write Property: Lcl scaling. More... | |
| FBScene | Scene |
| Read Only Property: Scene containing the model. More... | |
| FBListShader | Shaders |
| List: Shaders for model. More... | |
| FBModelShadingMode | ShadingMode |
| Read Write Property: Shading mode for the model. More... | |
| bool | Show |
| Read Write Property: Indicate if the viewer should show the object, according to its visibility value. This has a default value of 'false'. More... | |
| bool | SkeletonDeformable |
| Read Write Property: Model skeleton deformable. Not Savable More... | |
| bool | SoftSelected |
| Read Write Property: Is model Soft selected? More... | |
| FBListTexture | Textures |
| List: Textures with Special UseType (Other than "Color" which should connect to materials). More... | |
| bool | Transformable |
| Read Write Property: Indicate if a model can be transformable in the viewer. This has a default value of 'true'. More... | |
| FBAnimatableVector3d | Translation |
| Read Write Property: Lcl translation. More... | |
| FBColor | UniqueColorId |
| Read Only Property: Unique Color Id for color based viewer picking. Color channel values are in the range [0, 1] with 1.0/255 precision. More... | |
| FBModel | UpVector |
| Read Write Property: UpVector model. More... | |
| FBAnimatableBool | Visibility |
| Read Write Property: Visibility of model. This can be overridden by the 'Show' property. More... | |
| bool | VisibilityInheritance |
| Read Write Property: //!< When this value is set to True the Visibility of this model is also applied to all its descendants More... | |
| Public Attributes inherited from FBBox | |
| bool | Animatable |
| Read Write Property: Is the box animatable. More... | |
| bool | Live |
| Read Write Property: Is live? More... | |
| bool | RecordMode |
| Read Write Property: Is recording? More... | |
| str | UniqueName |
| internal Unique name. More... | |
| Public Attributes inherited from FBComponent | |
| FBListComponent | Components |
| List: List of components. More... | |
| str | LongName |
| Read Write Property: Name and namespace for object. More... | |
| str | Name |
| Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py. More... | |
| FBListComponent | Parents |
| List: Parents. More... | |
| FBManager | PropertyList |
| Read Only Property: Manages all of the properties for the component. More... | |
| bool | Selected |
| Read Write Property: Selected property. More... | |
| int | TypeInfo |
| Contains the Type information of the object. More... | |
| Public Attributes inherited from FBPlug | |
| str | ClassGroupName |
| ClassGroupName of the object. More... | |
| int | TypeInfo |
| TypeInfo. More... | |
| FBModelCube | ( | str | pName | ) |
Constructor.
| pName | Name of cube. |
1.8.20