FBMesh Class Reference
 
 
 
FBMesh Class Reference

#include <mobu-python-api.h>


Class Description

Mesh class.

Inheritance diagram for FBMesh:
FBGeometry FBComponent FBPlug FBPythonWrapper

Public Member Functions

def  __reduce__ ()
def  __init__ ()
def  PolygonBegin ()
def  PolygonCount ()
def  PolygonEnd ()
def  PolygonMaterialIdGet ()
def  PolygonVertexAdd ()
def  PolygonVertexCount ()
def  PolygonVertexIndex ()
def  PolygonVertexArrayGet ()
def  IsTriangleMesh ()
def  TriangleListAdd ()
def  TriangleStripAdd ()
def  PolygonListAdd ()
def  ComputeVertexNormals ()
def  InverseNormal ()
def  GetUVSets ()
def  VertexUVGet ()
def  VertexColorGet ()
def  VertexNormalGet ()
def  VertexGet ()
def  GeometryEnd ()
def  GeometryBegin ()
def  VertexAdd ()
def  VertexClear ()
def  VertexArrayClear ()
def  VertexCount ()
def  VertexGetSelected ()
def  VertexGetTransformable ()
def  VertexGetVisible ()
def  VertexInit ()
def  VertexArrayInit ()
def  VertexNormalSet ()
def  VertexColorSet ()
def  VertexSet ()
def  VertexSetSelected ()
def  VertexSetVisible ()
def  VertexUVSet ()
def  GetPositionsArray ()
def  SetPositionsArray ()
def  GetNormalsDirectArray ()
def  SetNormalsDirectArray ()
def  GetNormalsIndexArray ()
def  SetNormalsIndexArray ()
def  GetTangentsDirectArray ()
def  SetTangentsDirectArray ()
def  GetTangentsIndexArray ()
def  SetTangentsIndexArray ()
def  GetBinormalsDirectArray ()
def  SetBinormalsDirectArray ()
def  GetBinormalsIndexArray ()
def  SetBinormalsIndexArray ()
def  GetVertexColorsDirectArray ()
def  SetVertexColorsDirectArray ()
def  GetVertexColorsIndexArray ()
def  SetVertexColorsIndexArray ()
def  GetUVSetDirectArray ()
def  SetUVSetDirectArray ()
def  GetUVSetIndexArray ()
def  SetUVSetIndexArray ()
def  GetMaterialIndexArray ()
def  SetMaterialIndexArray ()
def  ShapeGetCount ()
def  ShapeGetName ()
def  ShapeAdd ()
def  ShapeClearAll ()
def  ShapeInit ()
def  ShapeSetDiffPoint ()
def  ShapeGetDiffPoint ()
def  GetUVSetMappingMode ()
def  GetUVSetReferenceMode ()
def  PropertyGetModifiedList ()
def  ClassName ()
def  DisableObjectFlags ()
def  EnableObjectFlags ()
def  FBCreate ()
def  FBDelete ()
def  FBDestroy ()
def  GetObjectFlags ()
def  GetObjectStatus ()
def  HasObjectFlags ()
def  Is ()
def  ProcessNamespaceHierarchy ()
def  ProcessObjectNamespace ()
def  PropertyAdd ()
def  PropertyAddReferenceProperty ()
def  PropertyCreate ()
def  PropertyRemove ()
def  SetObjectFlags ()
def  SetObjectStatus ()
def  HardSelect ()
def  GetOwnerFileReference ()
def  BeginChange ()
def  ConnectDst ()
def  ConnectDstAt ()
def  ConnectSrc ()
def  ConnectSrcAt ()
def  DisconnectAllDst ()
def  DisconnectAllSrc ()
def  DisconnectDst ()
def  DisconnectDstAt ()
def  DisconnectSrc ()
def  DisconnectSrcAt ()
def  EndChange ()
def  GetDst ()
def  GetDstCount ()
def  GetDstType ()
def  GetOwned ()
def  GetOwnedCount ()
def  GetOwner ()
def  GetSrc ()
def  GetSrcCount ()
def  GetSrcType ()
def  IsSDKComponent ()
def  MoveSrcAt ()
def  ReplaceDstAt ()
def  ReplaceSrcAt ()
def  SwapSrc ()
def  SetSelfModified ()
def  GetSelfModified ()
def  SetContentModified ()
def  GetContentModified ()
def  GetPlugConnectionModifiedList ()
def  RevertModification ()
def  PrintClassDefinitions ()

Public Attributes

FBPropertyGeometryMappingMode  MaterialMappingMode
FBPropertyGeometryMappingMode  NormalMappingMode
FBPropertyGeometryReferenceMode  NormalReferenceMode
FBPropertyGeometryMappingMode  TangentMappingMode
FBPropertyGeometryReferenceMode  TangentReferenceMode
FBPropertyGeometryMappingMode  BinormalMappingMode
FBPropertyGeometryReferenceMode  BinormalReferenceMode
FBPropertyGeometryMappingMode  VertexColorMappingMode
FBPropertyGeometryReferenceMode  VertexColorReferenceMode
object  OwnerNamespace
FBPropertyListComponent  Components
FBPropertyString  Name
FBPropertyString  LongName
object  FullName
FBPropertyListComponent  Parents
FBPropertyManager  PropertyList
FBPropertyBool  Selected
object  OnUnbind

Member Function Documentation

def __reduce__ ( )
def __init__ ( )

Python Docstring:

__init__( (object)arg1, (str)arg2) -> None 

C++ Signature:

 FBMesh(const char * pName, HIObject pObject = NULL) 

Constructor.

Parameters:
pName Name of Mesh.
pObject For internal use only(default=NULL).

Reimplemented from FBGeometry.

def PolygonBegin ( )

Python Docstring:

PolygonBegin( (FBMesh)arg1 [, (object)arg2]) -> int 

C++ Signature:

int PolygonBegin(int pMaterialId = 0) 

Begin Polygon definition.

Parameters:
pMaterialId Index of material for this polygon. Only effective when MaterialMappingMode is kFBGeometryMapping_BY_POLYGON mode.
Returns:
Number of existing polygons in Mesh
def PolygonCount ( )

Python Docstring:

PolygonCount( (FBMesh)arg1) -> int 

C++ Signature:

int PolygonCount() 

Get number of polygons in mesh.

Returns:
Number of polygons in mesh.
def PolygonEnd ( )

Python Docstring:

PolygonEnd( (FBMesh)arg1) -> int 

C++ Signature:

int PolygonEnd() 

End Polygon definition. Clean up and associate vertices internally.

Returns:
Current number of polygons.
Note:
MoBu expect each polygon to contain at least 3 vertices, the behavior is undefined if user add less than 3 vertices polygon.
def PolygonMaterialIdGet ( )

Python Docstring:

PolygonMaterialIdGet( (FBMesh)arg1 [, (object)arg2]) -> int 

C++ Signature:

int PolygonMaterialIdGet(int pIndex = -1) 

Get a Material ID for the given Polygon index.

Parameters:
pIndex Polygon's index to get material ID at (default=-1).
Returns:
ID of material of vertex at pIndex.
def PolygonVertexAdd ( )

Python Docstring:

PolygonVertexAdd( (FBMesh)arg1, (object)arg2) -> bool 

C++ Signature:

bool PolygonVertexAdd(int pVertex) 

Add a vertex.

Parameters:
pVertex Index in mesh of vertex to add to polygon, must be in range of [0, ControlPointCount)
Returns:
true if successful.
def PolygonVertexCount ( )

Python Docstring:

PolygonVertexCount( (FBMesh)arg1, (object)arg2) -> int 

C++ Signature:

int PolygonVertexCount(int pPolygonIndex) 

Get Polygon vertex count.

Parameters:
pPolygonIndex Index of polygon to get vertex count from.
Returns:
Number of vertices in polygon at pPolygonIndex.
def PolygonVertexIndex ( )

Python Docstring:

PolygonVertexIndex( (FBMesh)arg1, (object)arg2, (object)arg3) -> int 

C++ Signature:

int PolygonVertexIndex(int pPolygonIndex, int pVertexPolygonIndex) 

Get global (for the mesh) index of a vertex from a polygon.

Parameters:
pPolygonIndex Index of polygon in question.
pVertexPolygonIndex Polygon vertex index.
Returns:
Index in mesh of vertex.
def PolygonVertexArrayGet ( )

Python Docstring:

PolygonVertexArrayGet( (FBMesh)arg1) -> list 

C++ Signature:

const int * PolygonVertexArrayGet(int & pArraySize) 

Get the array of polygon vertex (i.e. index to control points). This array is a concatenation of the list of polygon vertices of all the polygons. Example: a mesh made of 2 triangles [1,2,3] and [2,3,4] results in [1,2,3,2,3,4]. The first polygon starts at position 0 and the second at position 3.

Parameters:
pArraySize Polygon vertex array size.
Returns:
Readonly polygon vertex array.
def IsTriangleMesh ( )

Python Docstring:

IsTriangleMesh( (FBMesh)arg1) -> bool 

C++ Signature:

bool IsTriangleMesh() 

Determines if the mesh is composed entirely of triangles.

Returns:
true if all polygons are triangles, false otherwise
def TriangleListAdd ( )

Python Docstring:

TriangleListAdd( (FBMesh)arg1, (object)arg2, (list)arg3 [, (object)arg4]) -> bool 

C++ Signature:

bool TriangleListAdd(int pIndexArraySize, int * pIndexArray, int pMaterialId = 0) 

Add Triangle List, Must be called in-between FBGeometry.GeometryBegin() / GeometryEnd() It's user's responsibility to make sure to input valid index values, otherwise afterwards behavior will be undefined.

Parameters:
pIndexArraySize Size of pIndexArray, Added triangle count is floor(max(pIndexArraySize, 0) / 3)
pIndexArray Index array of triangle list.
pMaterialId Index of material for this polygon. Only effective when MaterialMappingMode is kFBGeometryMapping_BY_POLYGON mode.
Note:
The indexes' value in input pIndexArray won't be validated, and the behavior is undefined if out of range.
def TriangleStripAdd ( )

Python Docstring:

TriangleStripAdd( (FBMesh)arg1, (object)arg2, (list)arg3 [, (object)arg4]) -> bool 

C++ Signature:

bool TriangleStripAdd(int pIndexArraySize, int * pIndexArray, int pMaterialId = 0) 

Add Triangle Strip Must be called in-between FBGeometry.GeometryBegin() / GeometryEnd() It's user's responsibility to make sure to input valid index values, otherwise afterwards behavior will be undefined.

Parameters:
pIndexArraySize Size of pIndexArray, Added triangle count is max(pIndexArraySize - 2, 0)
pIndexArray Index array of triangle strip.
pMaterialId Index of material for this polygon. Only effective when MaterialMappingMode is kFBGeometryMapping_BY_POLYGON mode.
Note:
The indexes' value in input pIndexArray won't be validated, and the behavior is undefined if out of range.
def PolygonListAdd ( )

Python Docstring:

PolygonListAdd( (FBMesh)arg1, (object)arg2, (object)arg3, (list)arg4 [, (object)arg5]) -> bool 

C++ Signature:

bool PolygonListAdd(int pPolygonSize, int pIndexArraySize, int * pIndexArray, int pMaterialId = 0) 

Add Polygon List Must be called in-between FBGeometry.GeometryBegin() / GeometryEnd() It's user's responsibility to make sure to input valid index values, otherwise afterwards behavior will be undefined.

Parameters:
pPolygonSize Size of polygon, 3 mean triangle, 4 for quadrilateral, and so on. minimum input value is 3.
pIndexArraySize Size of pIndexArray, Added polygon count is floor(max(pIndexArraySize, 0) / pPolygonSize)
pIndexArray Index array of triangle strip.
pMaterialId Index of material for this polygon. Only effective when MaterialMappingMode is kFBGeometryMapping_BY_POLYGON mode.
Note:
The indexes' value in input pIndexArray won't be validated, and the behavior is undefined if out of range.
def ComputeVertexNormals ( )

Python Docstring:

ComputeVertexNormals( (FBMesh)arg1 [, (object)arg2]) -> None 

C++ Signature:

void ComputeVertexNormals(bool pCW = false) 

Compute Mesh Vertex Normal.

Parameters:
pCW True for clock wise normal, otherwise for counter-clock wise
def InverseNormal ( )

Python Docstring:

InverseNormal( (FBMesh)arg1) -> None 

C++ Signature:

void InverseNormal() 

Inverse Normal.

def GetUVSets ( ) [inherited]

Python Docstring:

GetUVSets( (FBGeometry)arg1) -> FBStringList 

C++ Signature:

FBStringList GetUVSets() 

Get available UVSet name.

Returns:
StringList contain all the available UVSets' name.
def VertexUVGet ( ) [inherited]

Python Docstring:

VertexUVGet( (FBGeometry)arg1, (object)arg2) -> FBUV 

C++ Signature:

FBUV VertexUVGet(int pIndex = -1) 

Get a UV coordinate.

Parameters:
pIndex Index of Vertex to get UV coordinate for(default=-1).
Returns:
UV coordinate of vertex at UVSetIndex.
def VertexColorGet ( ) [inherited]

Python Docstring:

VertexColorGet( (FBGeometry)arg1, (object)arg2) -> FBColorAndAlpha 

C++ Signature:

FBColorF VertexColorGet(int pIndex = -1) 

Get a Vertex Color.

Parameters:
pIndex Index of Vertex to get Color for(default=-1).
Returns:
Color of vertex at 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.

Parameters:
pIndex Vertex to get normal at(default=-1).
Returns:
Normal of vertex at pIndex.
def VertexGet ( ) [inherited]

Python Docstring:

VertexGet( (FBGeometry)arg1, (object)arg2) -> FBVertex 

C++ Signature:

FBVertex VertexGet(int pIndex) 

Get a vertex.

Parameters:
pIndex Index of vertex to get.
Returns:
Vertex stored at pIndex.
def GeometryEnd ( ) [inherited]

Python Docstring:

GeometryEnd( (FBGeometry)arg1) -> bool 

C++ Signature:

bool GeometryEnd() 

End geometry editing.

Returns:
true if successful.
def GeometryBegin ( ) [inherited]

Python Docstring:

GeometryBegin( (FBGeometry)arg1) -> bool 

C++ Signature:

bool GeometryBegin() 

Begin geometry editing.

Returns:
true if successful.
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.,).

Returns:
true if successful.
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.,).

Returns:
true if successful.
def VertexCount ( ) [inherited]

Python Docstring:

VertexCount( (FBGeometry)arg1) -> int 

C++ Signature:

int VertexCount() 

Get the number of vertices in the geometry.

Returns:
Number of vertices in the geometry.
def VertexGetSelected ( ) [inherited]

Python Docstring:

VertexGetSelected( (FBGeometry)arg1, (object)arg2) -> bool 

C++ Signature:

bool VertexGetSelected(int pIndex) 

Get the selected state of a vertex.

Parameters:
pIndex The index of the vertex
Returns:
true if the vertex is selected, false if not

Reimplemented in FBSurface.

def VertexGetTransformable ( ) [inherited]

Python Docstring:

VertexGetTransformable( (FBGeometry)arg1, (object)arg2) -> bool 

C++ Signature:

bool VertexGetTransformable(int pIndex) 

Get the Transformable state of a vertex.

Parameters:
pIndex The index of the vertex
Returns:
true if the vertex is Transformable, false if not

Reimplemented in FBSurface.

def VertexGetVisible ( ) [inherited]

Python Docstring:

VertexGetVisible( (FBGeometry)arg1, (object)arg2) -> bool 

C++ Signature:

bool VertexGetVisible(int pIndex) 

Get the visible state of a vertex.

Parameters:
pIndex The index of the vertex
Returns:
true if the vertex is visible, false if not

Reimplemented in FBSurface.

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.

Parameters:
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.

Parameters:
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.

bool VertexNormalSet(FBNormal pVertex, int pIndex = -1)
bool VertexNormalSet(double px, double py, double pz, int pIndex = -1)
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.

bool VertexColorSet(FBColorF pColor, int pIndex = -1)
bool VertexColorSet(float pRed, float pGreen, float pBlue, float pAlpha, int pIndex = -1)
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.

bool VertexSet(FBVertex pVertex, int pIndex = -1)
bool VertexSet(double px, double py, double pz, int pIndex = -1)
def VertexSetSelected ( ) [inherited]

Python Docstring:

VertexSetSelected( (FBGeometry)arg1, (object)arg2, (object)arg3) -> bool 

C++ Signature:

bool VertexSetSelected(int pIndex, bool pState) 

Set the selected state of a vertex.

Parameters:
pIndex The index of the vertex
pState The true to selected, false to deselect
Returns:
true if the vertex is selected, false if not

Reimplemented in FBSurface.

def VertexSetVisible ( ) [inherited]

Python Docstring:

VertexSetVisible( (FBGeometry)arg1, (object)arg2, (object)arg3) -> bool 

C++ Signature:

bool VertexSetVisible(int pIndex, bool pState) 

Set the visible state of a vertex.

Parameters:
pIndex The index of the vertex
pState true to be visible
Returns:
true if the vertex is visible, false if not

Reimplemented in FBSurface.

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.

bool VertexUVSet(FBUV pUV, int pIndex = -1)
bool VertexUVSet(float pU, float pV, int pIndex = -1)
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.

See also:
GeometryBegin()/GeometryEnd()
Parameters:
pOutArrayCount To return the length the array.
Returns:
Pointer to index array of normals, or 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.

See also:
GeometryBegin()/GeometryEnd()
Parameters:
pOutArrayCount To return the length the array.
Returns:
Pointer to direct array of normals, or 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.

See also:
GeometryBegin()/GeometryEnd()
Parameters:
pOutArrayCount To return the length the array.
Returns:
Pointer to index array of normals, or 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.

See also:
GeometryBegin()/GeometryEnd()
Parameters:
pOutArrayCount To return the length the array.
Returns:
Pointer to direct array of tangents, or 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.

See also:
GeometryBegin()/GeometryEnd()
Parameters:
pOutArrayCount To return the length the array.
Returns:
Pointer to index array of tangents, or 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.

See also:
GeometryBegin()/GeometryEnd()
Parameters:
pOutArrayCount To return the length the array.
Returns:
Pointer to direct array of binormals, or 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.

See also:
GeometryBegin()/GeometryEnd()
Parameters:
pOutArrayCount To return the length the array.
Returns:
Pointer to index array of binormals, or 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.

See also:
GeometryBegin()/GeometryEnd()
Parameters:
pOutArrayCount To return the length the array.
Returns:
Pointer to direct array of vertex colors, or 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.

See also:
GeometryBegin()/GeometryEnd()
Parameters:
pOutArrayCount To return the length the array.
Returns:
Pointer to index array of vertex color, or 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.

See also:
GeometryBegin()/GeometryEnd()
Parameters:
pOutArrayCount To return the length the array.
pUVSetName The name of UVset, NULL for the first UVset.
Returns:
pointer to the array of UV, or 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.

See also:
GeometryBegin()/GeometryEnd()
Parameters:
pOutArrayCount To return the length the array.
pUVSetName The name of UVset, NULL for the first UVset.
Returns:
Pointer to index array of UVSet, or 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.

See also:
GeometryBegin()/GeometryEnd()
Parameters:
pOutArrayCount To return the length the array.
Returns:
Pointer to index array of Material, or 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.

Parameters:
pName the shape name
Returns:
the index of the new shape, -1 if the shape adding fail.
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.

Parameters:
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.

bool ShapeSetDiffPoint(int pShapeIdx, int pDiffIndex, int pOriIndex, const FBVertex & pPosDiff)
bool ShapeSetDiffPoint(int pShapeIdx, int pDiffIndex, int pOriIndex, const FBVertex & pPosDiff, const FBNormal & pNormalDiff)
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.

bool ShapeGetDiffPoint(int pShapeIdx, int pDiffIndex, int & pOriIndex, FBVertex & pPosDiff)
bool ShapeGetDiffPoint(int pShapeIdx, int pDiffIndex, int & pOriIndex, FBVertex & pPosDiff, FBNormal & pNormalDiff)
def GetUVSetMappingMode ( ) [inherited]

Python Docstring:

GetUVSetMappingMode( (FBGeometry)arg1 [, (str)arg2]) -> FBGeometryMappingMode 

C++ Signature:

FBGeometryMappingMode GetUVSetMappingMode(const char * pUVSetName = NULL) 

Get UVSet mapping mode.

Parameters:
pUVSetName The name of UVset, NULL for the first UVset.
Returns:
Mapping mode of the UVset.
def GetUVSetReferenceMode ( ) [inherited]

Python Docstring:

GetUVSetReferenceMode( (FBGeometry)arg1 [, (str)arg2]) -> FBGeometryReferenceMode 

C++ Signature:

FBGeometryReferenceMode GetUVSetReferenceMode(const char * pUVSetName = NULL) 

Get UVSet reference mode.

Parameters:
pUVSetName The name of UVset, NULL for the first UVset.
Returns:
Reference mode of the 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.

Parameters:
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.

Returns:
The class name (i.e. "FBComponent").

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.

Parameters:
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.

Parameters:
pFlags Flags to enable.
def FBCreate ( ) [inherited]

Python Docstring:

FBCreate( (FBComponent)arg1) -> bool 

C++ Signature:

bool FBCreate() 

Open Reality Creation function.

Returns:
Outcome of creation (true/false).

Reimplemented in FBAssetFile, FBAssetFolder, FBDevice, and FBDeviceOptical.

def FBDelete ( ) [inherited]
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).

Returns:
Get all object flags in one call. Flags can be 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.

Parameters:
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.

Parameters:
pFlags Flags to check if they are present.
Returns:
True if all flags in pFlags are enabled.
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.

Parameters:
pTypeId TypeId to compare object to.
Returns:
Result of the comparison.

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.

Parameters:
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.
Returns:
return true if process successful.
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.

Parameters:
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.
Returns:
return true if process successful.
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.

Parameters:
pProperty The property to add to the property manager.
Returns:
Index in the property array where property was inserted.
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.

Parameters:
pReferenceProperty The property to from an other object to add a reference to (property cannot be a custom ORSDK property).
Returns:
True if the reference property could be added.
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.

Parameters:
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.

Parameters:
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.

Parameters:
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.

Parameters:
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.

Returns:
the owner FileReference object
def BeginChange ( ) [inherited]

Python Docstring:

BeginChange( (FBPlug)arg1) -> bool 

C++ Signature:

bool BeginChange() 

Begins a change on multiple plugs.

Returns:
A boolean indicating success (True) or failure (False).
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.

Parameters:
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False)
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.

Parameters:
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.
Returns:
A boolean indicating success (True) or failure (False).
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.

Parameters:
pSrc Source plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
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.

Parameters:
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.
Returns:
A boolean indicating success (True) or failure (False).
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.

Parameters:
pDst Destination plug.
Returns:
A boolean indicating success (True) or failure (False).
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.

Parameters:
pIndex Destination plug index.
Returns:
A boolean indicating success (True) or failure (False).
def DisconnectSrc ( ) [inherited]

Python Docstring:

DisconnectSrc( (FBPlug)arg1, (FBPlug)arg2) -> bool 

C++ Signature:

bool DisconnectSrc(FBPlug * pSrc) 

Remove a source connection.

Parameters:
pSrc Source plug.
Returns:
A boolean indicating success (True) or failure (False).
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.

Parameters:
pIndex Source plug index.
Returns:
A boolean indicating success (True) or failure (False).
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.

Parameters:
pIndex Index of the destination connection's plug.
Returns:
Destination plug at specified index.
def GetDstCount ( ) [inherited]

Python Docstring:

GetDstCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetDstCount() 

Get destination connection count.

Returns:
Total destinations connections 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.

Parameters:
pIndex Index of the destination connection's type.
Returns:
Destination connection's type at specified index.
def GetOwned ( ) [inherited]

Python Docstring:

GetOwned( (FBPlug)arg1, (object)arg2) -> object 

C++ Signature:

FBPlug * GetOwned(int pIndex) 

Get the owned plug at specified index.

Parameters:
pIndex Index of the owned plug to get.
Returns:
The owned plug at specified index.
def GetOwnedCount ( ) [inherited]

Python Docstring:

GetOwnedCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetOwnedCount() 

Get the owned plug count.

Returns:
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.

Returns:
The owner of this plug.
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.

Parameters:
pIndex Index of the source connection's plug.
Returns:
Source plug at specified index.
def GetSrcCount ( ) [inherited]

Python Docstring:

GetSrcCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetSrcCount() 

Get source connection count.

Returns:
Total sources connections 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.

Parameters:
pIndex Index of the source connection's type.
Returns:
Source connection's type at specified index.
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.

bool MoveSrcAt(int pIndex, int pAtIndex)
bool MoveSrcAt(FBPlug * pSrc, FBPlug * pAtSrc)
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.

Parameters:
pIndex Destination plug index.
pDst Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
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.

Parameters:
pIndex Source plug index.
pSrc Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
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.

Parameters:
pIndexA Plug index.
pIndexB Other plug index.
Returns:
A boolean indicating success (True) or failure (False).
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.

Parameters:
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.

Parameters:
pFlag bitwise AND of self modification flags.
Returns:
true if self changed
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.

Parameters:
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.

Parameters:
pFlag bitwise AND of content modification flags.
Returns:
true if content connection changed.
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.

Parameters:
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.
Returns:
count of list;
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.

Parameters:
pFlag the type of modification to be reverted.
Returns:
true if revert successfully.
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.


Member Data Documentation

FBPropertyGeometryMappingMode MaterialMappingMode [inherited]

Read Property: Material mapping mode.

FBPropertyGeometryMappingMode NormalMappingMode [inherited]

Read Only Property: Normal mapping mode.

FBPropertyGeometryReferenceMode NormalReferenceMode [inherited]

Read Only Property: Normal reference mode.

FBPropertyGeometryMappingMode TangentMappingMode [inherited]

Read Only Property: Tangent mapping mode.

FBPropertyGeometryReferenceMode TangentReferenceMode [inherited]

Read Only Property: Tangent reference mode.

FBPropertyGeometryMappingMode BinormalMappingMode [inherited]

Read Only Property: Binormal mapping mode.

FBPropertyGeometryReferenceMode BinormalReferenceMode [inherited]

Read Only Property: Binormal reference mode.

FBPropertyGeometryMappingMode VertexColorMappingMode [inherited]

Read Only Property: Vertex Color mapping mode.

FBPropertyGeometryReferenceMode VertexColorReferenceMode [inherited]

Read Only Property: Vertex Color reference mode.

List: List of components.

Reimplemented in FBScene.

FBPropertyString Name [inherited]

Read Write Property: Unique name of object.

Reimplemented in FBAssetMng.

Read Write Property: Name and namespace for object.

Read Only Property: Manages all of the properties for the component.

FBPropertyBool Selected [inherited]

Read Write Property: Selected property.

Reimplemented in FBModel.