This reference page is linked to from the following overview topics: FBGeometry - Meshes and Surfaces.
#include <mobu-python-api.h>
Surface class.
def __reduce__ | ( | ) |
def ControlPointsEnd | ( | ) |
Python Docstring:
ControlPointsEnd( (FBSurface)arg1) -> None
C++ Signature:
void ControlPointsEnd()
def ControlPointsBegin | ( | ) |
Python Docstring:
ControlPointsBegin( (FBSurface)arg1) -> None
C++ Signature:
void ControlPointsBegin()
def GetControlPoint | ( | ) |
Python Docstring:
GetControlPoint( (FBSurface)arg1, (object)arg2, (object)arg3, (object)arg4, (object)arg5, (object)arg6) -> None
C++ Signature:
void GetControlPoint(int pIndex, double & pX, double & pY, double & pZ, double & pW)
def GetSurfaceCapped | ( | ) |
Python Docstring:
GetSurfaceCapped( (FBSurface)arg1, (object)arg2, (object)arg3) -> bool
C++ Signature:
bool GetSurfaceCapped(int pUorV, int pDirection)
def SetControlPoint | ( | ) |
Python Docstring:
SetControlPoint( (FBSurface)arg1, (object)arg2, (object)arg3, (object)arg4, (object)arg5, (object)arg6) -> None
C++ Signature:
void SetControlPoint(int pIndex, double pX, double pY, double pZ, double pW)
def SurfaceBegin | ( | ) |
Python Docstring:
SurfaceBegin( (FBSurface)arg1) -> None
C++ Signature:
void SurfaceBegin()
def SurfaceEditBegin | ( | ) |
Python Docstring:
SurfaceEditBegin( (FBSurface)arg1) -> None
C++ Signature:
void SurfaceEditBegin()
def SurfaceEditEnd | ( | ) |
Python Docstring:
SurfaceEditEnd( (FBSurface)arg1) -> None
C++ Signature:
void SurfaceEditEnd()
def SurfaceEnd | ( | ) |
Python Docstring:
SurfaceEnd( (FBSurface)arg1) -> None
C++ Signature:
void SurfaceEnd()
def VertexGetSelected | ( | ) |
Python Docstring:
VertexGetSelected( (FBSurface)arg1, (object)arg2, (object)arg3) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
Reimplemented from FBGeometry.
def VertexGetTransformable | ( | ) |
Python Docstring:
VertexGetTransformable( (FBSurface)arg1, (object)arg2, (object)arg3) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
Reimplemented from FBGeometry.
def VertexGetVisible | ( | ) |
Python Docstring:
VertexGetVisible( (FBSurface)arg1, (object)arg2, (object)arg3) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
Reimplemented from FBGeometry.
def VertexSetSelected | ( | ) |
Python Docstring:
VertexSetSelected( (FBSurface)arg1, (object)arg2, (object)arg3, (object)arg4) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
Reimplemented from FBGeometry.
def VertexSetVisible | ( | ) |
Python Docstring:
VertexSetVisible( (FBSurface)arg1, (object)arg2, (object)arg3, (object)arg4) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
Reimplemented from FBGeometry.
def __init__ | ( | ) |
Python Docstring:
Raises an exception This class cannot be instantiated from Python
C++ Signature:
FBSurface(const char * pName, HIObject pObject = NULL)
Constructor.
pName | Name of Surface. |
pObject | For internal use only(default=NULL). |
Reimplemented from FBGeometry.
def GetUVSets | ( | ) | [inherited] |
Python Docstring:
GetUVSets( (FBGeometry)arg1) -> FBStringList
C++ Signature:
FBStringList GetUVSets()
Get available UVSet name.
def VertexUVGet | ( | ) | [inherited] |
Python Docstring:
VertexUVGet( (FBGeometry)arg1, (object)arg2) -> FBUV
C++ Signature:
FBUV VertexUVGet(int pIndex = -1)
Get a UV coordinate.
pIndex | Index of Vertex to get UV coordinate for(default=-1). |
UVSetIndex
.def VertexColorGet | ( | ) | [inherited] |
Python Docstring:
VertexColorGet( (FBGeometry)arg1, (object)arg2) -> FBColorAndAlpha
C++ Signature:
FBColorF VertexColorGet(int pIndex = -1)
Get a Vertex Color.
pIndex | Index of Vertex to get Color for(default=-1). |
UVSetIndex
.def VertexNormalGet | ( | ) | [inherited] |
Python Docstring:
VertexNormalGet( (FBGeometry)arg1, (object)arg2) -> FBNormal
C++ Signature:
FBNormal VertexNormalGet(int pIndex = -1)
Get a normal at a vertex.
pIndex | Vertex to get normal at(default=-1). |
pIndex
.def VertexGet | ( | ) | [inherited] |
Python Docstring:
VertexGet( (FBGeometry)arg1, (object)arg2) -> FBVertex
C++ Signature:
FBVertex VertexGet(int pIndex)
Get a vertex.
pIndex | Index of vertex to get. |
pIndex
.def GeometryEnd | ( | ) | [inherited] |
Python Docstring:
GeometryEnd( (FBGeometry)arg1) -> bool
C++ Signature:
bool GeometryEnd()
End geometry editing.
def GeometryBegin | ( | ) | [inherited] |
Python Docstring:
GeometryBegin( (FBGeometry)arg1) -> bool
C++ Signature:
bool GeometryBegin()
Begin geometry editing.
def VertexAdd | ( | ) | [inherited] |
Python Docstring:
VertexAdd( (FBGeometry)arg1, (FBVertex)arg2) -> int VertexAdd( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4) -> int
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
int VertexAdd(FBVertex pVertex) int VertexAdd(FBVertex pVertex, FBNormal pNormal) int VertexAdd(FBVertex pVertex, FBNormal pNormal, FBUV pUV) int VertexAdd(FBVertex pVertex, FBNormal pNormal, FBUV pUV, FBColorF pVertexColor) int VertexAdd(double px, double py, double pz) int VertexAdd(double px, double py, double pz, double nx, double ny, double nz) int VertexAdd(double px, double py, double pz, double nx, double ny, double nz, double UVu, double UVv) int VertexAdd(double px, double py, double pz, double nx, double ny, double nz, double UVu, double UVv, double pRed, double pGreen, double pBlue, double pAlpha)
def VertexClear | ( | ) | [inherited] |
Python Docstring:
VertexClear( (FBGeometry)arg1) -> bool
C++ Signature:
bool VertexClear()
Clear all Vertex arrays. Call this function to clear Position, Normal, UV, Color and etc vertex arrays, and it won't affect geometry's topology (polygon, Surface and etc.,).
def VertexArrayClear | ( | ) | [inherited] |
Python Docstring:
VertexArrayClear( (FBGeometry)arg1) -> bool
C++ Signature:
bool VertexArrayClear()
Clear all geometry vertex arrays. Call this function to clear Position, Normal, UV, Color and etc vertex arrays, and it won't affect geometry's topology (polygon, Surface and etc.,).
def VertexCount | ( | ) | [inherited] |
Python Docstring:
VertexCount( (FBGeometry)arg1) -> int
C++ Signature:
int VertexCount()
Get the number of vertices in the geometry.
def VertexInit | ( | ) | [inherited] |
Python Docstring:
VertexInit( (FBGeometry)arg1, (object)arg2, (object)arg3 [, (object)arg4 [, (object)arg5]]) -> None
C++ Signature:
void VertexInit(int pSize, bool pResize, bool pInitUV = true, bool pInitVertexColor = false)
Resize or Reserve vertex, normal and UV array for performance.
pSize | Number of vertices to resize or reserve. |
pResize | True, for the geometry with known vertex count, we should resize the arrays to fixed size, and call VertexSet() afterwards; False, While for dynamic size geometry, we should only reserve the arrays with the estimated optimal size, then call VertexAdd() to dynamically increase the vertex count. |
pInitUV | init Vertex UV array if true |
pInitVertexColor | Init Vertex Color Array if true. |
def VertexArrayInit | ( | ) | [inherited] |
Python Docstring:
VertexArrayInit( (FBGeometry)arg1, (object)arg2, (object)arg3 [, (int)arg4]) -> bool
C++ Signature:
bool VertexArrayInit(int pVertexcount, bool pUniqueMaterial, unsigned int pFBGeometryArrayIDs = 0)
Init geometry vertex arrays. Init position, normal and UV arrays (tangent, bi-normal and color on demand) with kFBGeometryMapping_BY_CONTROL_POINT / kFBGeometryReference_DIRECT mode. Will call VertexArrayClear() internally. User should then call GetXXXDirectyArray() to edit the vertex attributes directly.
pVertexcount | number of control points (vertex) |
pUniqueMaterial | User could specify per polygon mapping mode for mesh |
pFBGeometryArrayIDs | Request to init other attribute arrays, bitwise combined value of FBGeometryArrayID enum items, currently support Tangent, Binormal and VertexColor. Only useful for mesh. |
def VertexNormalSet | ( | ) | [inherited] |
Python Docstring:
VertexNormalSet( (FBGeometry)arg1, (FBNormal)arg2 [, (object)arg3]) -> bool VertexNormalSet( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4 [, (object)arg5]) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def VertexColorSet | ( | ) | [inherited] |
Python Docstring:
VertexColorSet( (FBGeometry)arg1, (FBColorAndAlpha)arg2 [, (object)arg3]) -> bool VertexColorSet( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4, (object)arg5 [, (object)arg6]) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def VertexSet | ( | ) | [inherited] |
Python Docstring:
VertexSet( (FBGeometry)arg1, (FBVertex)arg2 [, (object)arg3]) -> bool VertexSet( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4 [, (object)arg5]) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def VertexUVSet | ( | ) | [inherited] |
Python Docstring:
VertexUVSet( (FBGeometry)arg1, (FBUV)arg2 [, (object)arg3]) -> bool VertexUVSet( (FBGeometry)arg1, (float)arg2, (float)arg3 [, (object)arg4]) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def GetPositionsArray | ( | ) | [inherited] |
Python Docstring:
GetPositionsArray( (FBGeometry)arg1) -> list
C++ Signature:
FBVertex * GetPositionsArray(int & pOutArrayCount)
Get a pointer to the position array. Modify array value will be only effective when geometry editing is enabled.
pOutArrayCount | To return the length the array. |
NULL
if the
array hasn't been allocated yet.def SetPositionsArray | ( | ) | [inherited] |
Python Docstring:
SetPositionsArray( (FBGeometry)arg1, (list)arg2) -> bool
def GetNormalsDirectArray | ( | ) | [inherited] |
Python Docstring:
GetNormalsDirectArray( (FBGeometry)arg1) -> list
C++ Signature:
FBNormal * GetNormalsDirectArray(int & pOutArrayCount)
Get a pointer to the direct array of normals. Modify array value will be only effective when geometry editing is enabled.
pOutArrayCount | To return the length the array. |
NULL
if the
array hasn't been allocated yet.def SetNormalsDirectArray | ( | ) | [inherited] |
Python Docstring:
SetNormalsDirectArray( (FBGeometry)arg1, (list)arg2) -> bool
def GetNormalsIndexArray | ( | ) | [inherited] |
Python Docstring:
GetNormalsIndexArray( (FBGeometry)arg1) -> list
C++ Signature:
int * GetNormalsIndexArray(int & pOutArrayCount)
Get a pointer to the index array of normals. Modify array value will be only effective when geometry editing is enabled.
pOutArrayCount | To return the length the array. |
NULL
if the
array hasn't been allocated yet.def SetNormalsIndexArray | ( | ) | [inherited] |
Python Docstring:
SetNormalsIndexArray( (FBGeometry)arg1, (list)arg2) -> bool
def GetTangentsDirectArray | ( | ) | [inherited] |
Python Docstring:
GetTangentsDirectArray( (FBGeometry)arg1) -> list
C++ Signature:
FBNormal * GetTangentsDirectArray(int & pOutArrayCount)
Get a pointer to the direct array of tangents. Modify array value will be only effective when geometry editing is enabled.
pOutArrayCount | To return the length the array. |
NULL
if
the array hasn't been allocated yet.def SetTangentsDirectArray | ( | ) | [inherited] |
Python Docstring:
SetTangentsDirectArray( (FBGeometry)arg1, (list)arg2) -> bool
def GetTangentsIndexArray | ( | ) | [inherited] |
Python Docstring:
GetTangentsIndexArray( (FBGeometry)arg1) -> list
C++ Signature:
int * GetTangentsIndexArray(int & pOutArrayCount)
Get a pointer to the index array of tangents. Modify array value will be only effective when geometry editing is enabled.
pOutArrayCount | To return the length the array. |
NULL
if the
array hasn't been allocated yet.def SetTangentsIndexArray | ( | ) | [inherited] |
Python Docstring:
SetTangentsIndexArray( (FBGeometry)arg1, (list)arg2) -> bool
def GetBinormalsDirectArray | ( | ) | [inherited] |
Python Docstring:
GetBinormalsDirectArray( (FBGeometry)arg1) -> list
C++ Signature:
FBNormal * GetBinormalsDirectArray(int & pOutArrayCount)
Get a pointer to the direct array of binormals. Modify array value will be only effective when geometry editing is enabled.
pOutArrayCount | To return the length the array. |
NULL
if
the array hasn't been allocated yet.def SetBinormalsDirectArray | ( | ) | [inherited] |
Python Docstring:
SetBinormalsDirectArray( (FBGeometry)arg1, (list)arg2) -> bool
def GetBinormalsIndexArray | ( | ) | [inherited] |
Python Docstring:
GetBinormalsIndexArray( (FBGeometry)arg1) -> list
C++ Signature:
int * GetBinormalsIndexArray(int & pOutArrayCount)
Get a pointer to the index array of binormals. Modify array value will be only effective when geometry editing is enabled.
pOutArrayCount | To return the length the array. |
NULL
if
the array hasn't been allocated yet.def SetBinormalsIndexArray | ( | ) | [inherited] |
Python Docstring:
SetBinormalsIndexArray( (FBGeometry)arg1, (list)arg2) -> bool
def GetVertexColorsDirectArray | ( | ) | [inherited] |
Python Docstring:
GetVertexColorsDirectArray( (FBGeometry)arg1) -> list
C++ Signature:
FBColorF * GetVertexColorsDirectArray(int & pOutArrayCount)
Get a pointer to the direct array of vertex color. Modify array value will be only effective when geometry editing is enabled.
pOutArrayCount | To return the length the array. |
NULL
if the array hasn't been allocated yet.def SetVertexColorsDirectArray | ( | ) | [inherited] |
Python Docstring:
SetVertexColorsDirectArray( (FBGeometry)arg1, (list)arg2) -> bool
def GetVertexColorsIndexArray | ( | ) | [inherited] |
Python Docstring:
GetVertexColorsIndexArray( (FBGeometry)arg1) -> list
C++ Signature:
int * GetVertexColorsIndexArray(int & pOutArrayCount)
Get a pointer to the index array of vertex color. Modify array value will be only effective when geometry editing is enabled.
pOutArrayCount | To return the length the array. |
NULL
if
the array hasn't been allocated yet.def SetVertexColorsIndexArray | ( | ) | [inherited] |
Python Docstring:
SetVertexColorsIndexArray( (FBGeometry)arg1, (list)arg2) -> bool
def GetUVSetDirectArray | ( | ) | [inherited] |
Python Docstring:
GetUVSetDirectArray( (FBGeometry)arg1 [, (str)arg2]) -> list
C++ Signature:
FBUV * GetUVSetDirectArray(int & pOutArrayCount, const char * pUVSetName = NULL)
Get a pointer to the direct array of UVset Modify array value will be only effective when geometry editing is enabled.
pOutArrayCount | To return the length the array. |
pUVSetName | The name of UVset, NULL for the first UVset. |
NULL
is the array
hasn't been allocated yet.def SetUVSetDirectArray | ( | ) | [inherited] |
Python Docstring:
SetUVSetDirectArray( (FBGeometry)arg1, (list)arg2 [, (str)arg3]) -> bool
def GetUVSetIndexArray | ( | ) | [inherited] |
Python Docstring:
GetUVSetIndexArray( (FBGeometry)arg1 [, (str)arg2]) -> list
C++ Signature:
int * GetUVSetIndexArray(int & pOutArrayCount, const char * pUVSetName = NULL)
Get a pointer to the index array of UVset. Modify array value will be only effective when geometry editing is enabled.
pOutArrayCount | To return the length the array. |
pUVSetName | The name of UVset, NULL for the first UVset. |
NULL
if the
array hasn't been allocated yet.def SetUVSetIndexArray | ( | ) | [inherited] |
Python Docstring:
SetUVSetIndexArray( (FBGeometry)arg1, (list)arg2 [, (str)arg3]) -> bool
def GetMaterialIndexArray | ( | ) | [inherited] |
Python Docstring:
GetMaterialIndexArray( (FBGeometry)arg1) -> list
C++ Signature:
int * GetMaterialIndexArray(int & pOutArrayCount)
Get a pointer to the index array of Material. Modify array value will be only effective when geometry editing is enabled.
pOutArrayCount | To return the length the array. |
NULL
if the
array hasn't been allocated yet.def SetMaterialIndexArray | ( | ) | [inherited] |
Python Docstring:
SetMaterialIndexArray( (FBGeometry)arg1, (list)arg2) -> bool
def ShapeGetCount | ( | ) | [inherited] |
Python Docstring:
ShapeGetCount( (FBGeometry)arg1) -> int
C++ Signature:
int ShapeGetCount()
Get Shape Count.
def ShapeGetName | ( | ) | [inherited] |
Python Docstring:
ShapeGetName( (FBGeometry)arg1, (object)arg2) -> str
C++ Signature:
const char * ShapeGetName(int pShapeIdx)
Return the shape Name.
def ShapeAdd | ( | ) | [inherited] |
Python Docstring:
ShapeAdd( (FBGeometry)arg1, (str)arg2) -> int
C++ Signature:
int ShapeAdd(const char * pName)
Add new shape.
pName | the shape name |
def ShapeClearAll | ( | ) | [inherited] |
Python Docstring:
ShapeClearAll( (FBGeometry)arg1) -> None
C++ Signature:
void ShapeClearAll()
Clears all the shapes.
def ShapeInit | ( | ) | [inherited] |
Python Docstring:
ShapeInit( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4) -> None
C++ Signature:
void ShapeInit(int pShapeIdx, int pDiffSize, bool pWithNormal = false)
Init the shape.
pShapeIdx | The index of the shape to be initialized |
pDiffSize | Total number of different point (pos or normal) compared to base geometry. |
pWithNormal | Currently normal won't be considered during shape blending. |
def ShapeSetDiffPoint | ( | ) | [inherited] |
Python Docstring:
ShapeSetDiffPoint( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4, (FBVertex)arg5 [, (FBNormal)arg6]) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def ShapeGetDiffPoint | ( | ) | [inherited] |
Python Docstring:
ShapeGetDiffPoint( (FBGeometry)arg1, (object)arg2, (object)arg3, (object)arg4, (FBVertex)arg5, (FBNormal)arg6) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def GetUVSetMappingMode | ( | ) | [inherited] |
Python Docstring:
GetUVSetMappingMode( (FBGeometry)arg1 [, (str)arg2]) -> FBGeometryMappingMode
C++ Signature:
FBGeometryMappingMode GetUVSetMappingMode(const char * pUVSetName = NULL)
Get UVSet mapping mode.
pUVSetName | The name of UVset, NULL for the first UVset. |
def GetUVSetReferenceMode | ( | ) | [inherited] |
Python Docstring:
GetUVSetReferenceMode( (FBGeometry)arg1 [, (str)arg2]) -> FBGeometryReferenceMode
C++ Signature:
FBGeometryReferenceMode GetUVSetReferenceMode(const char * pUVSetName = NULL)
Get UVSet reference mode.
pUVSetName | The name of UVset, NULL for the first UVset. |
def PropertyGetModifiedList | ( | ) | [inherited] |
Python Docstring:
PropertyGetModifiedList( (FBComponent)arg1, (FBPlugModificationFlag)arg2) -> FBPropertyList
C++ Signature:
void PropertyGetModifiedList(FBArrayTemplate< FBProperty * > & pPropList, FBPlugModificationFlag pModificationFlags)
Get list of properties which have been modified since last loading.
pPropList | property list to hold the modified properties. |
pModificationFlags | type of modification to query. |
def ClassName | ( | ) | [inherited] |
Python Docstring:
ClassName( (FBComponent)arg1) -> str
C++ Signature:
const char * ClassName()
Get the class name.
Reimplemented from FBPlug.
def DisableObjectFlags | ( | ) | [inherited] |
Python Docstring:
DisableObjectFlags( (FBComponent)arg1, (FBObjectFlag)arg2) -> None
C++ Signature:
void DisableObjectFlags(FBObjectFlag pFlags)
Disable a specific Object Flags.
pFlags | Flags to disable. |
def EnableObjectFlags | ( | ) | [inherited] |
Python Docstring:
EnableObjectFlags( (FBComponent)arg1, (FBObjectFlag)arg2) -> None
C++ Signature:
void EnableObjectFlags(FBObjectFlag pFlags)
Enable a specific Object Flags.
pFlags | Flags to enable. |
def FBCreate | ( | ) | [inherited] |
Python Docstring:
FBCreate( (FBComponent)arg1) -> bool
C++ Signature:
bool FBCreate()
Open Reality Creation function.
Reimplemented in FBAssetFile, FBAssetFolder, FBDevice, and FBDeviceOptical.
def FBDelete | ( | ) | [inherited] |
Python Docstring:
FBDelete( (FBComponent)arg1) -> None
C++ Signature:
void FBDelete()
Open Reality deletion function.
Reimplemented in FBActor, FBActorFace, FBAnimationLayer, FBAudioClip, FBCharacter, FBCharacterExtension, FBCharacterFace, FBFileReference, FBFilter, FBFolder, FBGenericMenu, FBGroup, FBImage, FBKeyingGroup, FBLayeredTexture, FBModel, FBMotionClip, FBNamespace, FBScene, FBSet, FBStoryClip, FBStoryFolder, FBStoryTrack, FBTake, FBTexture, and FBVideoClip.
def FBDestroy | ( | ) | [inherited] |
Python Docstring:
FBDestroy( (FBComponent)arg1) -> None
C++ Signature:
void FBDestroy()
Open Reality destruction function.
Reimplemented in FBAssetFile, FBAssetFolder, FBDevice, and FBDeviceOptical.
def GetObjectFlags | ( | ) | [inherited] |
Python Docstring:
GetObjectFlags( (FBComponent)arg1) -> FBObjectFlag
C++ Signature:
FBObjectFlag GetObjectFlags()
Get all Object Flags (concatenated).
def GetObjectStatus | ( | ) | [inherited] |
Python Docstring:
GetObjectStatus( (FBComponent)arg1, (FBObjectStatus)arg2) -> bool
C++ Signature:
bool GetObjectStatus(FBObjectStatus pStatus)
Check to see if an object status is enabled.
pStatus | Status to query. |
def HasObjectFlags | ( | ) | [inherited] |
Python Docstring:
HasObjectFlags( (FBComponent)arg1, (FBObjectFlag)arg2) -> bool
C++ Signature:
bool HasObjectFlags(FBObjectFlag pFlags)
Check whether a specific object flag is enabled.
pFlags | Flags to check if they are present. |
def Is | ( | ) | [inherited] |
Python Docstring:
Is( (FBComponent)arg1, (object)arg2) -> bool
C++ Signature:
bool Is(int pTypeId)
Returns true if object is of type TypeId.
pTypeId | TypeId to compare object to. |
Reimplemented from FBPlug.
def ProcessNamespaceHierarchy | ( | ) | [inherited] |
Python Docstring:
ProcessNamespaceHierarchy( (FBComponent)arg1, (FBNamespaceAction)arg2, (str)arg3 [, (str)arg4 [, (object)arg5]]) -> bool
C++ Signature:
bool ProcessNamespaceHierarchy(FBNamespaceAction pNamespaceAction, const char * pNamespaceName, const char * pReplaceTo = NULL, bool pAddRight = true)
ProcessNamespaceHierarchy. New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This recursive function goes through the whole hierarchy (children) to add/replace the prefix. If you need to work on a single object, use the ProcessObjectPrefix function.
pNamespaceAction | Which operation to do on the hierarchy (children). |
pNamespaceName | The Namespace name on Add/Delete or the prefix to replace in case of replace. |
pReplaceTo | The new Namespace Name or NULL in case of add or delete. |
pAddRight | Whether to add the namespace on right-most or left-most side or other namespace. |
def ProcessObjectNamespace | ( | ) | [inherited] |
Python Docstring:
ProcessObjectNamespace( (FBComponent)arg1, (FBNamespaceAction)arg2, (str)arg3 [, (str)arg4 [, (object)arg5]]) -> bool
C++ Signature:
bool ProcessObjectNamespace(FBNamespaceAction pNamespaceAction, const char * pNamespaceName, const char * pReplaceTo = NULL, bool pAddRight = true)
ProcessObjectNamespace. New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This function is the same as ProcessNamespaceHierarchy except that it applies only on the current object and not to the object's children.
pNamespaceAction | Which operation to do on the hierarchy (children). |
pNamespaceName | The Namespace name on Add/Delete or the prefix to replace in case of replace. |
pReplaceTo | The new Namespace Name or NULL in case of add or delete. |
pAddRight | Whether to add the namespace on right-most or left-most side or other namespace. |
def PropertyAdd | ( | ) | [inherited] |
Python Docstring:
PropertyAdd( (FBComponent)arg1, (FBProperty)arg2) -> int
C++ Signature:
int PropertyAdd(FBProperty * pProperty)
Add a property to the component's property manager.
pProperty | The property to add to the property manager. |
def PropertyAddReferenceProperty | ( | ) | [inherited] |
Python Docstring:
PropertyAddReferenceProperty( (FBComponent)arg1, (FBProperty)arg2) -> bool
C++ Signature:
bool PropertyAddReferenceProperty(FBProperty * pReferenceProperty)
Add a reference property to the component's property manager.
pReferenceProperty | The property to from an other object to add a reference to (property cannot be a custom ORSDK property). |
def PropertyCreate | ( | ) | [inherited] |
Python Docstring:
PropertyCreate( (FBComponent)arg1, (str)arg2, (FBPropertyType)arg3, (str)arg4, (object)arg5, (object)arg6, (FBProperty)arg7) -> object
C++ Signature:
FBProperty * PropertyCreate(const char * pName, FBPropertyType pType, const char * pDataType, bool pAnimatable, bool pIsUser = false, FBProperty * pReferenceSource = NULL)
Create user or dynamic property.
pName | The name of the property. |
pType | Type of the property. See enum FBPropertyType. |
pDataType | DataType of the property. |
pAnimatable | To specify if the property can be animated. |
pIsUser | To specify if the property is available as a custom property or dynamic and attached to the object. |
pReferenceSource | Specifies the property that a reference refers to. |
def PropertyRemove | ( | ) | [inherited] |
Python Docstring:
PropertyRemove( (FBComponent)arg1, (FBProperty)arg2) -> None
C++ Signature:
void PropertyRemove(FBProperty * pProperty)
Remove a Property from the component's Property manager. If the property was dynamically allocated, it is deleted.
pProperty | The property to remove from the property manager. |
def SetObjectFlags | ( | ) | [inherited] |
Python Docstring:
SetObjectFlags( (FBComponent)arg1, (FBObjectFlag)arg2) -> None
C++ Signature:
void SetObjectFlags(FBObjectFlag pFlags)
SetObjectFlags.
pFlags | Set flag values. Note: this function overwrites all flags with those passed in parameter. |
def SetObjectStatus | ( | ) | [inherited] |
Python Docstring:
SetObjectStatus( (FBComponent)arg1, (FBObjectStatus)arg2, (object)arg3) -> None
C++ Signature:
void SetObjectStatus(FBObjectStatus pStatus, bool pValue)
Enable/Disable a specific Object Status.
pStatus | Status to change. |
pValue | Value to change the status to. |
def HardSelect | ( | ) | [inherited] |
Python Docstring:
HardSelect( (FBComponent)arg1) -> None
C++ Signature:
void HardSelect()
HardSelect. Selects the object, and emits a hard select event for UI update notification.
def GetOwnerFileReference | ( | ) | [inherited] |
Python Docstring:
GetOwnerFileReference( (FBComponent)arg1) -> object
C++ Signature:
FBFileReference * GetOwnerFileReference(void )
Get the owner FileReference object.
def BeginChange | ( | ) | [inherited] |
Python Docstring:
BeginChange( (FBPlug)arg1) -> bool
C++ Signature:
bool BeginChange()
Begins a change on multiple plugs.
def ConnectDst | ( | ) | [inherited] |
Python Docstring:
ConnectDst( (FBPlug)arg1, (FBPlug)arg2 [, (FBConnectionType)arg3]) -> bool
C++ Signature:
bool ConnectDst(FBPlug * pDst, FBConnectionType pConnectionType = kFBConnectionTypeNone)
Add a destination connection.
pDst | Destination plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
def ConnectDstAt | ( | ) | [inherited] |
Python Docstring:
ConnectDstAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3 [, (FBConnectionType)arg4]) -> bool
C++ Signature:
bool ConnectDstAt(int pSrc_DstIndex, FBPlug * pDst, FBConnectionType pConnectionType = kFBConnectionTypeNone)
Add a destination connection.
pSrc_DstIndex | Index that tells where to add this destination connection in the source's connection list. if index is out of bound, and this destination connection will be appended at the end. |
pDst | Destination plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
def ConnectSrc | ( | ) | [inherited] |
Python Docstring:
ConnectSrc( (FBPlug)arg1, (FBPlug)arg2 [, (FBConnectionType)arg3]) -> bool
C++ Signature:
bool ConnectSrc(FBPlug * pSrc, FBConnectionType pConnectionType = kFBConnectionTypeNone)
Add a source connection.
pSrc | Source plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
def ConnectSrcAt | ( | ) | [inherited] |
Python Docstring:
ConnectSrcAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3 [, (FBConnectionType)arg4]) -> bool
C++ Signature:
bool ConnectSrcAt(int pDst_SrcIndex, FBPlug * pSrc, FBConnectionType pConnectionType = kFBConnectionTypeNone)
Add a source connection.
pDst_SrcIndex | Index that tells where to add this source connection in the destination's connection list. if index is out of bound, and this source connection will be appended at the end. |
pSrc | Source plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
def DisconnectAllDst | ( | ) | [inherited] |
Python Docstring:
DisconnectAllDst( (FBPlug)arg1) -> None
C++ Signature:
void DisconnectAllDst()
Remove all destination connections.
def DisconnectAllSrc | ( | ) | [inherited] |
Python Docstring:
DisconnectAllSrc( (FBPlug)arg1) -> None
C++ Signature:
void DisconnectAllSrc()
Remove all source connections.
def DisconnectDst | ( | ) | [inherited] |
Python Docstring:
DisconnectDst( (FBPlug)arg1, (FBPlug)arg2) -> bool
C++ Signature:
bool DisconnectDst(FBPlug * pDst)
Remove a destination connection.
pDst | Destination plug. |
def DisconnectDstAt | ( | ) | [inherited] |
Python Docstring:
DisconnectDstAt( (FBPlug)arg1, (object)arg2) -> bool
C++ Signature:
bool DisconnectDstAt(int pIndex)
Remove a destination connection at a specified index.
pIndex | Destination plug index. |
def DisconnectSrc | ( | ) | [inherited] |
Python Docstring:
DisconnectSrc( (FBPlug)arg1, (FBPlug)arg2) -> bool
C++ Signature:
bool DisconnectSrc(FBPlug * pSrc)
Remove a source connection.
pSrc | Source plug. |
def DisconnectSrcAt | ( | ) | [inherited] |
Python Docstring:
DisconnectSrcAt( (FBPlug)arg1, (object)arg2) -> bool
C++ Signature:
bool DisconnectSrcAt(int pIndex)
Remove a source connection at a specified index.
pIndex | Source plug index. |
def EndChange | ( | ) | [inherited] |
Python Docstring:
EndChange( (FBPlug)arg1) -> None
C++ Signature:
void EndChange()
Ends a change on multiple plugs.
def GetDst | ( | ) | [inherited] |
Python Docstring:
GetDst( (FBPlug)arg1, (object)arg2) -> object
C++ Signature:
FBPlug * GetDst(int pIndex)
Get a destination connection's plug at specified index.
pIndex | Index of the destination connection's plug. |
def GetDstCount | ( | ) | [inherited] |
Python Docstring:
GetDstCount( (FBPlug)arg1) -> int
C++ Signature:
int GetDstCount()
Get destination connection count.
def GetDstType | ( | ) | [inherited] |
Python Docstring:
GetDstType( (FBPlug)arg1, (object)arg2) -> FBConnectionType
C++ Signature:
FBConnectionType GetDstType(int pIndex)
Get a destination connection's type at specified index.
pIndex | Index of the destination connection's type. |
def GetOwned | ( | ) | [inherited] |
Python Docstring:
GetOwned( (FBPlug)arg1, (object)arg2) -> object
C++ Signature:
FBPlug * GetOwned(int pIndex)
Get the owned plug at specified index.
pIndex | Index of the owned plug to get. |
def GetOwnedCount | ( | ) | [inherited] |
Python Docstring:
GetOwnedCount( (FBPlug)arg1) -> int
C++ Signature:
int GetOwnedCount()
Get the owned plug count.
def GetOwner | ( | ) | [inherited] |
Python Docstring:
GetOwner( (FBPlug)arg1) -> object
C++ Signature:
FBPlug * GetOwner()
Get the owner of this plug. Very useful for properties since they are plugs too.
def GetSrc | ( | ) | [inherited] |
Python Docstring:
GetSrc( (FBPlug)arg1, (object)arg2) -> object
C++ Signature:
FBPlug * GetSrc(int pIndex)
Get a source connection's plug at specified index.
pIndex | Index of the source connection's plug. |
def GetSrcCount | ( | ) | [inherited] |
Python Docstring:
GetSrcCount( (FBPlug)arg1) -> int
C++ Signature:
int GetSrcCount()
Get source connection count.
def GetSrcType | ( | ) | [inherited] |
Python Docstring:
GetSrcType( (FBPlug)arg1, (object)arg2) -> FBConnectionType
C++ Signature:
FBConnectionType GetSrcType(int pIndex)
Get a source connection's type at specified index.
pIndex | Index of the source connection's type. |
def IsSDKComponent | ( | ) | [inherited] |
Python Docstring:
IsSDKComponent( (FBPlug)arg1) -> bool
C++ Signature:
bool IsSDKComponent()
Return whether or not item is an SDK component.
def MoveSrcAt | ( | ) | [inherited] |
Python Docstring:
MoveSrcAt( (FBPlug)arg1, (object)arg2, (object)arg3) -> bool MoveSrcAt( (FBPlug)arg1, (FBPlug)arg2, (FBPlug)arg3) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def ReplaceDstAt | ( | ) | [inherited] |
Python Docstring:
ReplaceDstAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3) -> bool
C++ Signature:
bool ReplaceDstAt(int pIndex, FBPlug * pDst)
Replace a destination connection at a specified index.
pIndex | Destination plug index. |
pDst | Plug that will replace the other at index. |
def ReplaceSrcAt | ( | ) | [inherited] |
Python Docstring:
ReplaceSrcAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3) -> bool
C++ Signature:
bool ReplaceSrcAt(int pIndex, FBPlug * pSrc)
Replace a source connection at a specified index.
pIndex | Source plug index. |
pSrc | Plug that will replace the other at index. |
def SwapSrc | ( | ) | [inherited] |
Python Docstring:
SwapSrc( (FBPlug)arg1, (object)arg2, (object)arg3) -> bool
C++ Signature:
bool SwapSrc(int pIndexA, int pIndexB)
Swap source connection at index A with source connection at index B.
pIndexA | Plug index. |
pIndexB | Other plug index. |
def SetSelfModified | ( | ) | [inherited] |
Python Docstring:
SetSelfModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2, (object)arg3) -> None
C++ Signature:
void SetSelfModified(FBPlugModificationFlag pFlag, bool pBool)
Set the plug's self modification flag.
pFlag | bitwise AND of self modification flags. |
pBool | true if self changed. |
def GetSelfModified | ( | ) | [inherited] |
Python Docstring:
GetSelfModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2) -> bool
C++ Signature:
bool GetSelfModified(FBPlugModificationFlag pFlag)
Tell if the plug's self has changed.
pFlag | bitwise AND of self modification flags. |
def SetContentModified | ( | ) | [inherited] |
Python Docstring:
SetContentModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2, (object)arg3) -> None
C++ Signature:
void SetContentModified(FBPlugModificationFlag pFlag, bool pBool)
Set the plug's owned property/object's modification flag.
pFlag | bitwise AND of content modification flags. |
pBool | true if content has modification. |
def GetContentModified | ( | ) | [inherited] |
Python Docstring:
GetContentModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2) -> bool
C++ Signature:
bool GetContentModified(FBPlugModificationFlag pFlag)
Tell if the plug's content has changed.
pFlag | bitwise AND of content modification flags. |
def GetPlugConnectionModifiedList | ( | ) | [inherited] |
Python Docstring:
GetPlugConnectionModifiedList( (FBPlug)arg1, (FBPlugList)arg2, (FBPlugModificationFlag)arg3, (object)arg4) -> int
C++ Signature:
int GetPlugConnectionModifiedList(FBArrayTemplate & pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
Get plug's modified src/dst property/object connection added/removed List.
pPlugList | plug list to fill up. |
pConnectionModificatonFlag | Src/Dst Property/Object connection modification flag. |
pAddRemove | Ask for the added list if true, removed list if false. |
def RevertModification | ( | ) | [inherited] |
Python Docstring:
RevertModification( (FBPlug)arg1 [, (FBPlugModificationFlag)arg2]) -> bool
C++ Signature:
bool RevertModification(FBPlugModificationFlag pFlag = kFBAllModifiedMask)
Revert the plug's modification to original status.
pFlag | the type of modification to be reverted. |
def PrintClassDefinitions | ( | ) | [inherited] |
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.
C++ Signature:
void PrintClassDefinitions()
Print out internal Class (ID) Definition table. For internal debug purpose only.
FBPropertySurfaceMode SurfaceMode |
FBPropertyGeometryMappingMode MaterialMappingMode
[inherited] |
FBPropertyGeometryMappingMode NormalMappingMode
[inherited] |
FBPropertyGeometryReferenceMode NormalReferenceMode
[inherited] |
FBPropertyGeometryMappingMode TangentMappingMode
[inherited] |
FBPropertyGeometryReferenceMode TangentReferenceMode
[inherited] |
FBPropertyGeometryMappingMode BinormalMappingMode
[inherited] |
FBPropertyGeometryReferenceMode BinormalReferenceMode
[inherited] |
FBPropertyGeometryMappingMode VertexColorMappingMode
[inherited] |
FBPropertyGeometryReferenceMode VertexColorReferenceMode
[inherited] |
object OwnerNamespace
[inherited] |
FBPropertyListComponent
Components
[inherited] |
List: List of components.
Reimplemented in FBScene.
FBPropertyString Name
[inherited] |
Read Write Property: Unique name of object.
Reimplemented in FBAssetMng.
FBPropertyString LongName
[inherited] |
Read Write Property: Name and namespace for object.
object FullName
[inherited] |
FBPropertyListComponent
Parents
[inherited] |
FBPropertyManager PropertyList
[inherited] |
Read Only Property: Manages all of the properties for the component.
FBPropertyBool Selected
[inherited] |
Read Write Property: Selected property.
Reimplemented in FBModel.
object OnUnbind
[inherited] |