FBPatch Class Reference
 
 
 
FBPatch Class Reference

This reference page is linked to from the following overview topics: Scene Elements, FBModel - Transformation Data and the Scene Graph, Updated Objects, FBGeometry - Meshes and Surfaces.


#include <fbgeometry.h>


Class Description

Patch class.

Definition at line 960 of file fbgeometry.h.

Inheritance diagram for FBPatch:
FBSurface FBGeometry FBComponent FBPlug FBWrapperHolder

Public Member Functions

  FBPatch (const char *pName, HIObject pObject=NULL)
  Constructor.
virtual void  SurfaceBegin ()
  Begin Patch definition.
virtual void  SurfaceEnd ()
  End Patch definition.
virtual void  SurfaceEditBegin ()
  Begin patch surface edit.
virtual void  SurfaceEditEnd ()
  End patch surface edit.
virtual void  ControlPointsBegin ()
  Begin control points edition.
virtual void  ControlPointsEnd ()
  End control points edition.
virtual bool  GetSurfaceCapped (int pUorV, int pDirection)
virtual int  GetVertexCount (int pUorVorGlobal=-1)
virtual void  SetControlPoint (int pIndex, double pX, double pY, double pZ, double pW)
virtual void  GetControlPoint (int pIndex, double &pX, double &pY, double &pZ, double &pW)
bool  VertexGetSelected (int pU, int pV)
  Get the selected state of a vertex.
bool  VertexSetSelected (int pU, int pV, bool pState)
  Set the selected state of a vertex.
bool  VertexGetVisible (int pU, int pV)
  Get the visible state of a vertex.
bool  VertexSetVisible (int pU, int pV, bool pState)
  Set the visible state of a vertex.
bool  VertexGetTransformable (int pU, int pV)
  Get the Transformable state of a vertex.
void  VertexInit (int pSize, bool pResize, bool pInitUV=true, bool pInitVertexColor=false)
  Resize or Reserve vertex, normal and UV array for performance.
bool  VertexClear ()
  Clear all Vertex arrays.
int  VertexAdd (FBVertex pVertex)
  Add a vertex.
int  VertexAdd (FBVertex pVertex, FBNormal pNormal)
  Add a vertex.
int  VertexAdd (FBVertex pVertex, FBNormal pNormal, FBUV pUV)
  Add a vertex.
int  VertexAdd (FBVertex pVertex, FBNormal pNormal, FBUV pUV, FBColorF pVertexColor)
  Add a vertex.
int  VertexAdd (double px, double py, double pz)
  Add a vertex.
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)
bool  VertexSet (FBVertex pVertex, int pIndex=-1)
  Set a vertex.
bool  VertexSet (double px, double py, double pz, int pIndex=-1)
  Set a vertex.
bool  VertexNormalSet (FBNormal pVertex, int pIndex=-1)
  Set a normal at a vertex.
bool  VertexNormalSet (double px, double py, double pz, int pIndex=-1)
  Set a normal at a vertex.
bool  VertexUVSet (FBUV pUV, int pIndex=-1)
  Set a UV coordinate.
bool  VertexUVSet (float pU, float pV, int pIndex=-1)
  Set a UV coordinate.
bool  VertexColorSet (FBColorF pColor, int pIndex=-1)
  Set a Vertex Color.
bool  VertexColorSet (float pRed, float pGreen, float pBlue, float pAlpha, int pIndex=-1)
  Set a UV coordinate.
virtual bool  FBCreate ()
  Open Reality Creation function.
virtual void  FBDestroy ()
  Open Reality destruction function.
virtual void  FBDelete () override
  Open Reality deletion function.
virtual bool  SetHIObject (HIObject pObject, bool pSDKComponent) override
  Assign component to an internal pointer.
virtual int  PropertyAdd (FBProperty *pProperty)
  Add a property to the component's property manager.
bool  PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
  Add a reference property to the component's property manager.
void  PropertyRemove (FBProperty *pProperty)
  Remove a Property from the component's Property manager.
void  PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
  Get list of properties which have been modified since last loading.
FBProperty PropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
  Create user or dynamic property.
FBObjectFlag  GetObjectFlags ()
  Get all Object Flags (concatenated).
void  SetObjectFlags (FBObjectFlag pFlags)
  SetObjectFlags.
bool  HasObjectFlags (FBObjectFlag pFlags)
  Check whether a specific object flag is enabled.
void  EnableObjectFlags (FBObjectFlag pFlags)
  Enable a specific Object Flags.
void  DisableObjectFlags (FBObjectFlag pFlags)
  Disable a specific Object Flags.
void  SetObjectStatus (FBObjectStatus pStatus, bool pValue)
  Enable/Disable a specific Object Status.
bool  GetObjectStatus (FBObjectStatus pStatus)
  Check to see if an object status is enabled.
bool  ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
  ProcessNamespaceHierarchy.
bool  ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true)
  ProcessObjectNamespace.
virtual const char *  ClassName () override
  Get the class name.
virtual bool  UseCustomPropertyViewSet () const
  Use the custom property viewSet or not.
const char *  GetFullName (void)
  Get the full name.
void  SetOwnerNamespace (FBNamespace *pOwnerNSObj)
  Set the owner Namespace object.
FBNamespace GetOwnerNamespace (void)
  Get the owner Namespace object.
FBFileReference GetOwnerFileReference (void)
  Get the owner FileReference object.
void  HardSelect ()
  HardSelect.
  IObject_Declare (K_IMPLEMENTATION)
  ICallback_Declare (K_IMPLEMENTATION)
virtual bool  Is (int pTypeId)
  Returns true if object is of type TypeId.
virtual int  GetTypeId ()
  GetTypeId( int pTypeId )
void  KObjectEvent (HIRegister pView, HKEventBase pEvent)
virtual HIObject  GetHIObject () const
  Return an internal pointer.
bool  IsSDKComponent ()
  Return whether or not item is an SDK component.
bool  ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a source connection.
bool  ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a destination connection.
bool  ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a source connection.
bool  ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a destination connection.
bool  DisconnectDst (FBPlug *pDst)
  Remove a destination connection.
bool  DisconnectSrc (FBPlug *pSrc)
  Remove a source connection.
void  DisconnectAllSrc ()
  Remove all source connections.
void  DisconnectAllDst ()
  Remove all destination connections.
bool  DisconnectDstAt (int pIndex)
  Remove a destination connection at a specified index.
bool  DisconnectSrcAt (int pIndex)
  Remove a source connection at a specified index.
bool  ReplaceDstAt (int pIndex, FBPlug *pDst)
  Replace a destination connection at a specified index.
bool  ReplaceSrcAt (int pIndex, FBPlug *pSrc)
  Replace a source connection at a specified index.
bool  SwapSrc (int pIndexA, int pIndexB)
  Swap source connection at index A with source connection at index B.
bool  MoveSrcAt (int pIndex, int pAtIndex)
  Move source connection at pIndex to pAtIndex.
bool  MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
  Move source connection pSrc to the position of pAtSrc.
int  GetSrcCount ()
  Get source connection count.
FBPlug GetSrc (int pIndex)
  Get a source connection's plug at specified index.
FBConnectionType  GetSrcType (int pIndex)
  Get a source connection's type at specified index.
int  GetDstCount ()
  Get destination connection count.
FBPlug GetDst (int pIndex)
  Get a destination connection's plug at specified index.
FBConnectionType  GetDstType (int pIndex)
  Get a destination connection's type at specified index.
bool  BeginChange ()
  Begins a change on multiple plugs.
void  EndChange ()
  Ends a change on multiple plugs.
void  SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
  Set the plug's self modification flag.
bool  GetSelfModified (FBPlugModificationFlag pFlag)
  Tell if the plug's self has changed.
void  SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
  Set the plug's owned property/object's modification flag.
bool  GetContentModified (FBPlugModificationFlag pFlag)
  Tell if the plug's content has changed.
int  GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
  Get plug's modified src/dst property/object connection added/removed List.
bool  RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
  Revert the plug's modification to original status.
void  SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
  Set the plug's status flag.
bool  GetStatusFlag (FBPlugStatusFlag pStatus) const
  Tell if the plug's status has changed.
FBPlug GetOwner ()
  Get the owner of this plug.
FBPlug GetOwned (int pIndex)
  Get the owned plug at specified index.
int  GetOwnedCount ()
  Get the owned plug count.
virtual bool  PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
  PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.
virtual bool  PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
  PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.
virtual bool  PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
  PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.
FBScriptWrapper GetWrapper ()
  Return the wrapper interface of this FBObject.
void  AddWrapper (FBScriptWrapper *)
void  RemoveWrapper (FBScriptWrapper *)
Vertex Selection/Manipulation Interface.
bool  VertexGetSelected (int pIndex)
  Get the selected state of a vertex.
bool  VertexSetSelected (int pIndex, bool pState)
  Set the selected state of a vertex.
bool  VertexGetVisible (int pIndex)
  Get the visible state of a vertex.
bool  VertexSetVisible (int pIndex, bool pState)
  Set the visible state of a vertex.
bool  VertexGetTransformable (int pIndex)
  Get the Transformable state of a vertex.
Simple Geometry Editing Interface:

Geometries created with SDK can only use the kFBGeometryMapping_ALL_SAME or kFBGeometryMapping_BY_POLYGON mapping mode for material, kFBGeometryMapping_BY_CONTROL_POINT / kFBGeometryReference_DIRECT for Normal, UV, Color, Tangent and Binormal.

And only support one set of UV

bool  GeometryBegin ()
  Begin geometry editing.
bool  GeometryEnd ()
  End geometry editing.
bool  IsEditingEnabled () const
  Is geometry editing enabled.
Query interface for Vertex's Position, Normal, UV of default set.
int  VertexCount () const
  Get the number of vertices in the geometry.
FBVertex  VertexGet (int pIndex) const
  Get a vertex.
FBVertex GetVertexes () const
  Get a pointer to the array of vertexes.
FBNormal  VertexNormalGet (int pIndex=-1) const
  Get a normal at a vertex.
FBUV  VertexUVGet (int pIndex=-1) const
  Get a UV coordinate.
FBColorF  VertexColorGet (int pIndex=-1) const
  Get a Vertex Color.
Shape Management Interface
int  ShapeGetCount () const
  Get Shape Count.
const char *  ShapeGetName (int pShapeIdx) const
  Return the shape Name.
int  ShapeAdd (const char *pName)
  Add new shape.
void  ShapeClearAll ()
  Clears all the shapes.
void  ShapeInit (int pShapeIdx, int pDiffSize, bool pWithNormal=false)
  Init the shape.
int  ShapeGetDiffPointCount (int pShapeIdx) const
  Return the shape's total diff points count.
bool  ShapeSetDiffPoint (int pShapeIdx, int pDiffIndex, int pOriIndex, const FBVertex &pPosDiff)
  Set the differentiate point.
bool  ShapeSetDiffPoint (int pShapeIdx, int pDiffIndex, int pOriIndex, const FBVertex &pPosDiff, const FBNormal &pNormalDiff)
  Set the differentiate point.
bool  ShapeGetDiffPoint (int pShapeIdx, int pDiffIndex, int &pOriIndex, FBVertex &pPosDiff) const
  Get the differentiate point.
bool  ShapeGetDiffPoint (int pShapeIdx, int pDiffIndex, int &pOriIndex, FBVertex &pPosDiff, FBNormal &pNormalDiff) const
  Get the differentiate point.
Geometry Editing Notification
void  ModifyNotify (kFBGeometryUpdateFlags pFlags=kFBGeometryUpdateAll, int pFirstIndex=-1, int pLastIndex=-1)
  The geometry has change, update the necessary flags.
void *  operator new (size_t stAllocateBlock)
void *  operator new (size_t stAllocateBlock, int blockType, const char *filename, int linenumber)
void  operator delete (void *pvMem)
void  RegisterPropertyEvent (FBPropertyEvent *pPropertyEvent)
void  UnregisterPropertyEvent (FBPropertyEvent *pPropertyEvent)
void  InvalidatePropertyEventsParents ()

Static Public Member Functions

static int  GetInternalClassId ()
static void  FBComponentSetName (FBComponent *pObject, const char *pName)
static const char *  FBComponentGetName (FBComponent *pObject)
static void  FBComponentSetLongName (FBComponent *pObject, const char *pName)
static const char *  FBComponentGetLongName (FBComponent *pObject)
static void  PrintClassDefinitions ()
  Print out internal Class (ID) Definition table.

Public Attributes

FBPropertySurfaceType  USurfaceType
  Read Write Property: Patch mode for U direction.
FBPropertySurfaceType  VSurfaceType
  Read Write Property: Patch mode for V direction.
FBPropertyInt  USize
  Read Write Property: Size in U directions.
FBPropertyInt  VSize
  Read Write Property: Size in V directions.
FBPropertyInt  UStep
  Read Write Property: Step in U directions.
FBPropertyInt  VStep
  Read Write Property: Step in V directions.
FBPropertyBool  UClosed
  Read Write Property: U Closed.
FBPropertyBool  VClosed
  Read Write Property: V Closed
FBPropertySurfaceMode  SurfaceMode
  Read Write Property: Surface mode.
DataFBComponent *  mLocalPtr
  Handle on DataFBComponent.
FBPropertyManager  PropertyList
  Read Only Property: Manages all of the properties for the component.
FBPropertyListComponent  Components
  List: List of components.
FBPropertyListComponent  Parents
  List: Parents.
FBPropertyBool  Selected
  Read Write Property: Selected property.
FBPropertyString  Name
  Read Write Property: Unique name of object.
FBPropertyString  LongName
  Read Write Property: Name and namespace for object.
FBPropertyFolder  Folder
  Read Write Property: The folder that contain this component.
KObject *  mDummyObject
  Internal Dummy Object for non KObject Components.
bool  mAllocated
  Contain the Allocation State of the Component.

Static Public Attributes

static int  TypeInfo
  Contains the Type information of the object.
static const char *  ClassGroupName
  ClassGroupName of the object.

Protected Attributes

FBString  mName
  Name of the component.
HIObject  mObject
  Handle on the Plug.
bool  mSDKComponent
  bool Plug is an SDK component.

Static Protected Attributes

static int  mGlobalTypeInfo
  Represente the Type Index.

Friends

K_DLLIMPORT friend int  __FBRegisterTypeInfo (int pInternalClassId)
  __FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.

Interface for direct manipulating Geometry Position, Normal, Color, UV and Material arrays.

FBPropertyGeometryMappingMode  NormalMappingMode
  Read Only Property: Normal mapping mode.
FBPropertyGeometryReferenceMode  NormalReferenceMode
  Read Only Property: Normal reference mode.
FBPropertyGeometryMappingMode  TangentMappingMode
  Read Only Property: Tangent mapping mode.
FBPropertyGeometryReferenceMode  TangentReferenceMode
  Read Only Property: Tangent reference mode.
FBPropertyGeometryMappingMode  BinormalMappingMode
  Read Only Property: Binormal mapping mode.
FBPropertyGeometryReferenceMode  BinormalReferenceMode
  Read Only Property: Binormal reference mode.
FBPropertyGeometryMappingMode  VertexColorMappingMode
  Read Only Property: Vertex Color mapping mode.
FBPropertyGeometryReferenceMode  VertexColorReferenceMode
  Read Only Property: Vertex Color reference mode.
FBPropertyGeometryMappingMode  MaterialMappingMode
  Read Property: Material mapping mode.
bool  VertexArrayInit (int pVertexcount, bool pUniqueMaterial, unsigned int pFBGeometryArrayIDs=0)
  Init geometry vertex arrays.
bool  VertexArrayClear ()
  Clear all geometry vertex arrays.
FBVertex GetPositionsArray (int &pOutArrayCount) const
  Get a pointer to the position array.
int *  GetNormalsIndexArray (int &pOutArrayCount) const
  Get a pointer to the index array of normals.
FBNormal GetNormalsDirectArray (int &pOutArrayCount) const
  Get a pointer to the direct array of normals.
int *  GetTangentsIndexArray (int &pOutArrayCount) const
  Get a pointer to the index array of tangents.
FBNormal GetTangentsDirectArray (int &pOutArrayCount) const
  Get a pointer to the direct array of tangents.
int *  GetBinormalsIndexArray (int &pOutArrayCount) const
  Get a pointer to the index array of binormals.
FBNormal GetBinormalsDirectArray (int &pOutArrayCount) const
  Get a pointer to the direct array of binormals.
int *  GetVertexColorsIndexArray (int &pOutArrayCount) const
  Get a pointer to the index array of vertex color.
FBColorF GetVertexColorsDirectArray (int &pOutArrayCount) const
  Get a pointer to the direct array of vertex color.
FBStringList  GetUVSets () const
  Get available UVSet name.
FBGeometryMappingMode  GetUVSetMappingMode (const char *pUVSetName=NULL) const
  Get UVSet mapping mode.
FBGeometryReferenceMode  GetUVSetReferenceMode (const char *pUVSetName=NULL) const
  Get UVSet reference mode.
int *  GetUVSetIndexArray (int &pOutArrayCount, const char *pUVSetName=NULL) const
  Get a pointer to the index array of UVset.
FBUV GetUVSetDirectArray (int &pOutArrayCount, const char *pUVSetName=NULL) const
  Get a pointer to the direct array of UVset Modify array value will be only effective when geometry editing is enabled.
int *  GetMaterialIndexArray (int &pOutArrayCount) const
  Get a pointer to the index array of Material.

Constructor & Destructor Documentation

FBPatch::FBPatch ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

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

Member Function Documentation

virtual void FBPatch::SurfaceBegin ( ) [virtual]

Begin Patch definition.

Reimplemented from FBSurface.

virtual void FBPatch::SurfaceEnd ( ) [virtual]

End Patch definition.

Reimplemented from FBSurface.

virtual void FBPatch::SurfaceEditBegin ( ) [virtual]

Begin patch surface edit.

Reimplemented from FBSurface.

virtual void FBPatch::SurfaceEditEnd ( ) [virtual]

End patch surface edit.

Reimplemented from FBSurface.

virtual void FBPatch::ControlPointsBegin ( ) [virtual]

Begin control points edition.

Implements FBSurface.

virtual void FBPatch::ControlPointsEnd ( ) [virtual]

End control points edition.

Reimplemented from FBSurface.

virtual bool FBSurface::GetSurfaceCapped ( int  pUorV,
int  pDirection 
) [virtual, inherited]
virtual int FBSurface::GetVertexCount ( int  pUorVorGlobal = -1 ) [virtual, inherited]
virtual void FBSurface::SetControlPoint ( int  pIndex,
double  pX,
double  pY,
double  pZ,
double  pW 
) [virtual, inherited]
virtual void FBSurface::GetControlPoint ( int  pIndex,
double &  pX,
double &  pY,
double &  pZ,
double &  pW 
) [virtual, inherited]
bool FBSurface::VertexGetSelected ( int  pU,
int  pV 
) [inherited]

Get the selected state of a vertex.

Parameters:
pU The u index of the vertex.
pV The v index of the vertex.
Returns:
true if the vertex is selected, false if not.
bool FBGeometry::VertexGetSelected ( int  pIndex ) [inherited]

Get the selected state of a vertex.

Parameters:
pIndex The index of the vertex
Returns:
true if the vertex is selected, false if not
bool FBSurface::VertexSetSelected ( int  pU,
int  pV,
bool  pState 
) [inherited]

Set the selected state of a vertex.

Parameters:
pU The u index of the vertex.
pV The v index of the vertex.
pState Set the select state.
Returns:
true if the vertex is selected, false if not.
bool FBGeometry::VertexSetSelected ( int  pIndex,
bool  pState 
) [inherited]

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
bool FBSurface::VertexGetVisible ( int  pU,
int  pV 
) [inherited]

Get the visible state of a vertex.

Parameters:
pU The u index of the vertex.
pV The v index of the vertex.
Returns:
true if the vertex is visible, false if not.
bool FBGeometry::VertexGetVisible ( int  pIndex ) [inherited]

Get the visible state of a vertex.

Parameters:
pIndex The index of the vertex
Returns:
true if the vertex is visible, false if not
bool FBSurface::VertexSetVisible ( int  pU,
int  pV,
bool  pState 
) [inherited]

Set the visible state of a vertex.

Parameters:
pU The u index of the vertex.
pV The v index of the vertex.
pState Set the visible state.
Returns:
true if the vertex is visible, false if not.
bool FBGeometry::VertexSetVisible ( int  pIndex,
bool  pState 
) [inherited]

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
bool FBSurface::VertexGetTransformable ( int  pU,
int  pV 
) [inherited]

Get the Transformable state of a vertex.

Parameters:
pU The u index of the vertex.
pV The v index of the vertex.
Returns:
true if the vertex is Transformable, false if not.
bool FBGeometry::VertexGetTransformable ( int  pIndex ) [inherited]

Get the Transformable state of a vertex.

Parameters:
pIndex The index of the vertex
Returns:
true if the vertex is Transformable, false if not
bool FBGeometry::GeometryBegin ( ) [inherited]

Begin geometry editing.

Returns:
true if successful.
bool FBGeometry::GeometryEnd ( ) [inherited]

End geometry editing.

Returns:
true if successful.
bool FBGeometry::IsEditingEnabled ( ) const [inherited]

Is geometry editing enabled.

Returns:
true if enabled.
void FBGeometry::VertexInit ( int  pSize,
bool  pResize,
bool  pInitUV = true,
bool  pInitVertexColor = false 
) [inherited]

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.
bool FBGeometry::VertexClear ( ) [inherited]

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.
int FBGeometry::VertexAdd ( FBVertex  pVertex ) [inherited]

Add a vertex.

Parameters:
pVertex Vertex values used to add vertex.
Returns:
Index where vertex was added.
Remarks:
Set Normal with default value
int FBGeometry::VertexAdd ( FBVertex  pVertex,
FBNormal  pNormal 
) [inherited]

Add a vertex.

Parameters:
pVertex Vertex values used to add vertex.
pNormal Normal values used to add vertex.
Returns:
Index where vertex was added.
int FBGeometry::VertexAdd ( FBVertex  pVertex,
FBNormal  pNormal,
FBUV  pUV 
) [inherited]

Add a vertex.

Parameters:
pVertex Vertex values used to add vertex.
pNormal Normal values used to add vertex.
pUV UV values used to add vertex.
Returns:
Index where vertex was added.
int FBGeometry::VertexAdd ( FBVertex  pVertex,
FBNormal  pNormal,
FBUV  pUV,
FBColorF  pVertexColor 
) [inherited]

Add a vertex.

Parameters:
pVertex Vertex values used to add vertex.
pNormal Normal values used to add vertex.
pUV UV values used to add vertex.
pVertexColor Color values used to add vertex.
Returns:
Index where vertex was added.
int FBGeometry::VertexAdd ( double  px,
double  py,
double  pz 
) [inherited]

Add a vertex.

Parameters:
px X coordinate of vertex to add.
py Y coordinate of vertex to add.
pz Z coordinate of vertex to add.
Returns:
Index where vertex was added.
Remarks:
Set Normal with default value
int FBGeometry::VertexAdd ( double  px,
double  py,
double  pz,
double  nx,
double  ny,
double  nz 
) [inherited]
int FBGeometry::VertexAdd ( double  px,
double  py,
double  pz,
double  nx,
double  ny,
double  nz,
double  UVu,
double  UVv 
) [inherited]
int FBGeometry::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 
) [inherited]
bool FBGeometry::VertexSet ( FBVertex  pVertex,
int  pIndex = -1 
) [inherited]

Set a vertex.

Parameters:
pVertex Vertex values used to set vertex.
pIndex Index of vertex to affect (default=-1).
Returns:
true if successful.
bool FBGeometry::VertexSet ( double  px,
double  py,
double  pz,
int  pIndex = -1 
) [inherited]

Set a vertex.

Parameters:
px X coordinate to set.
py Y coordinate to set.
pz Z coordinate to set.
pIndex Index of vertex to set(default=-1).
Returns:
true if successful.
bool FBGeometry::VertexNormalSet ( FBNormal  pVertex,
int  pIndex = -1 
) [inherited]

Set a normal at a vertex.

Parameters:
pVertex Normal to set.
pIndex Index of vertex to set Normal at(default=-1).
Returns:
true if successful.
bool FBGeometry::VertexNormalSet ( double  px,
double  py,
double  pz,
int  pIndex = -1 
) [inherited]

Set a normal at a vertex.

Parameters:
px X coordinate of normal.
py Y coordinate of normal.
pz Z coordinate of normal.
pIndex Index of vertex to set Normal at(default=-1).
Returns:
true if successful.
bool FBGeometry::VertexUVSet ( FBUV  pUV,
int  pIndex = -1 
) [inherited]

Set a UV coordinate.

Parameters:
pUV UV coordinate to set.
pIndex Index of Vertex to affect with UV coordinate(default=-1).
Returns:
true if successful.
bool FBGeometry::VertexUVSet ( float  pU,
float  pV,
int  pIndex = -1 
) [inherited]

Set a UV coordinate.

Parameters:
pU U coordinate to set.
pV V coordinate to set.
pIndex Index of Vertex to affect with UV coordinate(default=-1).
Returns:
true if successful.
bool FBGeometry::VertexColorSet ( FBColorF  pColor,
int  pIndex = -1 
) [inherited]

Set a Vertex Color.

Parameters:
pColor Vertex Color to set.
pIndex Index of Vertex to affect with pColor(default=-1).
Returns:
true if successful.
bool FBGeometry::VertexColorSet ( float  pRed,
float  pGreen,
float  pBlue,
float  pAlpha,
int  pIndex = -1 
) [inherited]

Set a UV coordinate.

Parameters:
pRed Red Color Channel to set, range [0, 1].
pGreen Green Color Channel to set, range [0, 1].
pBlue Blue Color Channel to set, range [0, 1].
pAlpha Alpha Color Channel to set, range [0, 1].
pIndex Index of Vertex to affect with Red, Green, Blue and Alpha (default=-1).
Returns:
true if successful.
int FBGeometry::VertexCount ( ) const [inherited]

Get the number of vertices in the geometry.

Returns:
Number of vertices in the geometry.
FBVertex FBGeometry::VertexGet ( int  pIndex ) const [inherited]

Get a vertex.

Parameters:
pIndex Index of vertex to get.
Returns:
Vertex stored at pIndex.
FBVertex* FBGeometry::GetVertexes ( ) const [inherited]

Get a pointer to the array of vertexes.

Returns:
pointer to the array of vertexes, or NULL if the array has not been allocated.
FBNormal FBGeometry::VertexNormalGet ( int  pIndex = -1 ) const [inherited]

Get a normal at a vertex.

Parameters:
pIndex Vertex to get normal at(default=-1).
Returns:
Normal of vertex at pIndex.
FBUV FBGeometry::VertexUVGet ( int  pIndex = -1 ) const [inherited]

Get a UV coordinate.

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

Get a Vertex Color.

Parameters:
pIndex Index of Vertex to get Color for(default=-1).
Returns:
Color of vertex at UVSetIndex.
bool FBGeometry::VertexArrayInit ( int  pVertexcount,
bool  pUniqueMaterial,
unsigned int  pFBGeometryArrayIDs = 0 
) [inherited]

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.
bool FBGeometry::VertexArrayClear ( ) [inherited]

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.
FBVertex* FBGeometry::GetPositionsArray ( int &  pOutArrayCount ) const [inherited]

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.
int* FBGeometry::GetNormalsIndexArray ( int &  pOutArrayCount ) const [inherited]

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.
FBNormal* FBGeometry::GetNormalsDirectArray ( int &  pOutArrayCount ) const [inherited]

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.
int* FBGeometry::GetTangentsIndexArray ( int &  pOutArrayCount ) const [inherited]

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.
FBNormal* FBGeometry::GetTangentsDirectArray ( int &  pOutArrayCount ) const [inherited]

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.
int* FBGeometry::GetBinormalsIndexArray ( int &  pOutArrayCount ) const [inherited]

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.
FBNormal* FBGeometry::GetBinormalsDirectArray ( int &  pOutArrayCount ) const [inherited]

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.
int* FBGeometry::GetVertexColorsIndexArray ( int &  pOutArrayCount ) const [inherited]

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.
FBColorF* FBGeometry::GetVertexColorsDirectArray ( int &  pOutArrayCount ) const [inherited]

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.
FBStringList FBGeometry::GetUVSets ( ) const [inherited]

Get available UVSet name.

Returns:
StringList contain all the available UVSets' name.
FBGeometryMappingMode FBGeometry::GetUVSetMappingMode ( const char *  pUVSetName = NULL ) const [inherited]

Get UVSet mapping mode.

Parameters:
pUVSetName The name of UVset, NULL for the first UVset.
Returns:
Mapping mode of the UVset.
FBGeometryReferenceMode FBGeometry::GetUVSetReferenceMode ( const char *  pUVSetName = NULL ) const [inherited]

Get UVSet reference mode.

Parameters:
pUVSetName The name of UVset, NULL for the first UVset.
Returns:
Reference mode of the UVset.
int* FBGeometry::GetUVSetIndexArray ( int &  pOutArrayCount,
const char *  pUVSetName = NULL 
) const [inherited]

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.
FBUV* FBGeometry::GetUVSetDirectArray ( int &  pOutArrayCount,
const char *  pUVSetName = NULL 
) const [inherited]

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.
int* FBGeometry::GetMaterialIndexArray ( int &  pOutArrayCount ) const [inherited]

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.
int FBGeometry::ShapeGetCount ( ) const [inherited]

Get Shape Count.

const char* FBGeometry::ShapeGetName ( int  pShapeIdx ) const [inherited]

Return the shape Name.

int FBGeometry::ShapeAdd ( const char *  pName ) [inherited]

Add new shape.

Parameters:
pName the shape name
Returns:
the index of the new shape, -1 if the shape adding fail.
void FBGeometry::ShapeClearAll ( ) [inherited]

Clears all the shapes.

void FBGeometry::ShapeInit ( int  pShapeIdx,
int  pDiffSize,
bool  pWithNormal = false 
) [inherited]

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.
int FBGeometry::ShapeGetDiffPointCount ( int  pShapeIdx ) const [inherited]

Return the shape's total diff points count.

Parameters:
pShapeIdx The index of the shape
bool FBGeometry::ShapeSetDiffPoint ( int  pShapeIdx,
int  pDiffIndex,
int  pOriIndex,
const FBVertex pPosDiff 
) [inherited]

Set the differentiate point.

Parameters:
pShapeIdx The index of the shape
pDiffIndex The index of the diff point in this shape.
pOriIndex The index of the diff point in the original geometry.
pPosDiff The position differentiation.
bool FBGeometry::ShapeSetDiffPoint ( int  pShapeIdx,
int  pDiffIndex,
int  pOriIndex,
const FBVertex pPosDiff,
const FBNormal pNormalDiff 
) [inherited]

Set the differentiate point.

Parameters:
pShapeIdx The index of the shape
pDiffIndex The index of the diff point in this shape.
pOriIndex The index of the diff point in the original geometry.
pPosDiff The position differentiation.
pNormalDiff The normal differentiation.
bool FBGeometry::ShapeGetDiffPoint ( int  pShapeIdx,
int  pDiffIndex,
int &  pOriIndex,
FBVertex pPosDiff 
) const [inherited]

Get the differentiate point.

Parameters:
pShapeIdx The index of the shape
pDiffIndex The index of the diff point in this shape.
pOriIndex The index of the diff point in the original geometry.
pPosDiff The position differentiation.
bool FBGeometry::ShapeGetDiffPoint ( int  pShapeIdx,
int  pDiffIndex,
int &  pOriIndex,
FBVertex pPosDiff,
FBNormal pNormalDiff 
) const [inherited]

Get the differentiate point.

Parameters:
pShapeIdx The index of the shape
pDiffIndex The index of the diff point in this shape.
pOriIndex The index of the diff point in the original geometry.
pPosDiff The position differentiation.
pNormalDiff The normal differentiation.
void FBGeometry::ModifyNotify ( kFBGeometryUpdateFlags  pFlags = kFBGeometryUpdateAll,
int  pFirstIndex = -1,
int  pLastIndex = -1 
) [inherited]

The geometry has change, update the necessary flags.

Parameters:
pFlags flags for the kind of update that was done.
pFirstIndex Correspond to the start index of modification of points or normals.
pLastIndex Correspond to the last index of modification of points or normals.
FBComponent::GetInternalClassId ( ) [static, inherited]
Returns:
Internal class Id

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual bool FBComponent::FBCreate ( ) [virtual, inherited]
virtual void FBComponent::FBDestroy ( ) [virtual, inherited]
virtual bool FBComponent::SetHIObject ( HIObject  pObject,
bool  pSDKComponent 
) [override, virtual, inherited]

Assign component to an internal pointer.

Reimplemented from FBPlug.

virtual int FBComponent::PropertyAdd ( FBProperty pProperty ) [virtual, inherited]

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.
bool FBComponent::PropertyAddReferenceProperty ( FBProperty pReferenceProperty ) [inherited]

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.
void FBComponent::PropertyRemove ( FBProperty pProperty ) [inherited]

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.
void FBComponent::PropertyGetModifiedList ( FBArrayTemplate< FBProperty * > &  pPropList,
FBPlugModificationFlag  pModificationFlags 
) [inherited]

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.
FBProperty* FBComponent::PropertyCreate ( const char *  pName,
FBPropertyType  pType,
const char *  pDataType,
bool  pAnimatable,
bool  pIsUser = false,
FBProperty pReferenceSource = NULL 
) [inherited]

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.
FBObjectFlag FBComponent::GetObjectFlags ( ) [inherited]

Get all Object Flags (concatenated).

Returns:
Get all object flags in one call. Flags can be concatenated.
void FBComponent::SetObjectFlags ( FBObjectFlag  pFlags ) [inherited]

SetObjectFlags.

Parameters:
pFlags Set flag values. Note: this function overwrites all flags with those passed in parameter.
bool FBComponent::HasObjectFlags ( FBObjectFlag  pFlags ) [inherited]

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.
void FBComponent::EnableObjectFlags ( FBObjectFlag  pFlags ) [inherited]

Enable a specific Object Flags.

Parameters:
pFlags Flags to enable.
void FBComponent::DisableObjectFlags ( FBObjectFlag  pFlags ) [inherited]

Disable a specific Object Flags.

Parameters:
pFlags Flags to disable.
void FBComponent::SetObjectStatus ( FBObjectStatus  pStatus,
bool  pValue 
) [inherited]

Enable/Disable a specific Object Status.

Parameters:
pStatus Status to change.
pValue Value to change the status to.
bool FBComponent::GetObjectStatus ( FBObjectStatus  pStatus ) [inherited]

Check to see if an object status is enabled.

Parameters:
pStatus Status to query.
bool FBComponent::ProcessNamespaceHierarchy ( FBNamespaceAction  pNamespaceAction,
const char *  pNamespaceName,
const char *  pReplaceTo = NULL,
bool  pAddRight = true 
) [inherited]

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.
bool FBComponent::ProcessObjectNamespace ( FBNamespaceAction  pNamespaceAction,
const char *  pNamespaceName,
const char *  pReplaceTo = NULL,
bool  pAddRight = true 
) [inherited]

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.
virtual const char* FBComponent::ClassName ( ) [override, virtual, inherited]

Get the class name.

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

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual bool FBComponent::UseCustomPropertyViewSet ( ) const [inline, virtual, inherited]

Use the custom property viewSet or not.

To have custom property view for custom subclass, modification bin/config/propertyview.fbx is required.

Returns:
False if to use internal corresponding object's viewSet of the parent class.

Definition at line 791 of file fbcomponent.h.

{ return true; }
const char* FBComponent::GetFullName ( void  ) [inherited]

Get the full name.

Returns:
the full name of the component.
void FBComponent::SetOwnerNamespace ( FBNamespace pOwnerNSObj ) [inherited]

Set the owner Namespace object.

FBNamespace* FBComponent::GetOwnerNamespace ( void  ) [inherited]

Get the owner Namespace object.

Returns:
the owner Namespace object
FBFileReference* FBComponent::GetOwnerFileReference ( void  ) [inherited]

Get the owner FileReference object.

Returns:
the owner FileReference object
void FBComponent::HardSelect ( ) [inherited]

HardSelect.

Selects the object, and emits a hard select event for UI update notification.

void* FBComponent::operator new ( size_t  stAllocateBlock ) [inherited]
void* FBComponent::operator new ( size_t  stAllocateBlock,
int  blockType,
const char *  filename,
int  linenumber 
) [inherited]
void FBComponent::operator delete ( void *  pvMem ) [inherited]
void FBComponent::RegisterPropertyEvent ( FBPropertyEvent pPropertyEvent ) [inherited]
void FBComponent::UnregisterPropertyEvent ( FBPropertyEvent pPropertyEvent ) [inherited]
void FBComponent::InvalidatePropertyEventsParents ( ) [inherited]
FBComponent::ICallback_Declare ( K_IMPLEMENTATION  ) [inherited]

Reimplemented from FBPlug.

Reimplemented in FBModel, and FBVisualComponent.

virtual bool FBComponent::Is ( int  pTypeId ) [virtual, inherited]

Returns true if object is of type TypeId.

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

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

virtual int FBComponent::GetTypeId ( ) [virtual, inherited]

GetTypeId( int pTypeId )

Returns:
The TypeInfo of the object

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

static void FBComponent::FBComponentSetName ( FBComponent pObject,
const char *  pName 
) [static, inherited]
static const char* FBComponent::FBComponentGetName ( FBComponent pObject ) [static, inherited]
static void FBComponent::FBComponentSetLongName ( FBComponent pObject,
const char *  pName 
) [static, inherited]
static const char* FBComponent::FBComponentGetLongName ( FBComponent pObject ) [static, inherited]
void FBComponent::KObjectEvent ( HIRegister  pView,
HKEventBase  pEvent 
) [inherited]
virtual HIObject FBPlug::GetHIObject ( ) const [virtual, inherited]

Return an internal pointer.

bool FBPlug::IsSDKComponent ( ) [inherited]

Return whether or not item is an SDK component.

bool FBPlug::ConnectSrc ( FBPlug pSrc,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

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).
bool FBPlug::ConnectDst ( FBPlug pDst,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

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)
bool FBPlug::ConnectSrcAt ( int  pDst_SrcIndex,
FBPlug pSrc,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

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).
bool FBPlug::ConnectDstAt ( int  pSrc_DstIndex,
FBPlug pDst,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

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).
bool FBPlug::DisconnectDst ( FBPlug pDst ) [inherited]

Remove a destination connection.

Parameters:
pDst Destination plug.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectSrc ( FBPlug pSrc ) [inherited]

Remove a source connection.

Parameters:
pSrc Source plug.
Returns:
A boolean indicating success (True) or failure (False).
void FBPlug::DisconnectAllSrc ( ) [inherited]

Remove all source connections.

void FBPlug::DisconnectAllDst ( ) [inherited]

Remove all destination connections.

bool FBPlug::DisconnectDstAt ( int  pIndex ) [inherited]

Remove a destination connection at a specified index.

Parameters:
pIndex Destination plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectSrcAt ( int  pIndex ) [inherited]

Remove a source connection at a specified index.

Parameters:
pIndex Source plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ReplaceDstAt ( int  pIndex,
FBPlug pDst 
) [inherited]

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).
bool FBPlug::ReplaceSrcAt ( int  pIndex,
FBPlug pSrc 
) [inherited]

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).
bool FBPlug::SwapSrc ( int  pIndexA,
int  pIndexB 
) [inherited]

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).
bool FBPlug::MoveSrcAt ( int  pIndex,
int  pAtIndex 
) [inherited]

Move source connection at pIndex to pAtIndex.

Parameters:
pIndex Plug current index.
pAtIndex Plug new index.
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This is not like the swap function since the connection at pAtIndex is untouched.
bool FBPlug::MoveSrcAt ( FBPlug pSrc,
FBPlug pAtSrc 
) [inherited]

Move source connection pSrc to the position of pAtSrc.

Parameters:
pSrc Plug.
pAtSrc Plug that mark where we want to insert (will insert before this one).
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This is not like the swap function since the connection at pAtSrc is untouched.
int FBPlug::GetSrcCount ( ) [inherited]

Get source connection count.

Returns:
Total sources connections count.
FBPlug* FBPlug::GetSrc ( int  pIndex ) [inherited]

Get a source connection's plug at specified index.

Parameters:
pIndex Index of the source connection's plug.
Returns:
Source plug at specified index.
FBConnectionType FBPlug::GetSrcType ( int  pIndex ) [inherited]

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.
int FBPlug::GetDstCount ( ) [inherited]

Get destination connection count.

Returns:
Total destinations connections count.
FBPlug* FBPlug::GetDst ( int  pIndex ) [inherited]

Get a destination connection's plug at specified index.

Parameters:
pIndex Index of the destination connection's plug.
Returns:
Destination plug at specified index.
FBConnectionType FBPlug::GetDstType ( int  pIndex ) [inherited]

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.
bool FBPlug::BeginChange ( ) [inherited]

Begins a change on multiple plugs.

Returns:
A boolean indicating success (True) or failure (False).
void FBPlug::EndChange ( ) [inherited]

Ends a change on multiple plugs.

void FBPlug::SetSelfModified ( FBPlugModificationFlag  pFlag,
bool  pBool 
) [inherited]

Set the plug's self modification flag.

Parameters:
pFlag bitwise AND of self modification flags.
pBool true if self changed.
bool FBPlug::GetSelfModified ( FBPlugModificationFlag  pFlag ) [inherited]

Tell if the plug's self has changed.

Parameters:
pFlag bitwise AND of self modification flags.
Returns:
true if self changed
void FBPlug::SetContentModified ( FBPlugModificationFlag  pFlag,
bool  pBool 
) [inherited]

Set the plug's owned property/object's modification flag.

Parameters:
pFlag bitwise AND of content modification flags.
pBool true if content has modification.
bool FBPlug::GetContentModified ( FBPlugModificationFlag  pFlag ) [inherited]

Tell if the plug's content has changed.

Parameters:
pFlag bitwise AND of content modification flags.
Returns:
true if content connection changed.
int FBPlug::GetPlugConnectionModifiedList ( FBPlugList pPlugList,
FBPlugModificationFlag  pConnectionModificatonFlag,
bool  pAddRemove 
) [inherited]

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;
bool FBPlug::RevertModification ( FBPlugModificationFlag  pFlag = kFBAllModifiedMask ) [inherited]

Revert the plug's modification to original status.

Parameters:
pFlag the type of modification to be reverted.
Returns:
true if revert successfully.
void FBPlug::SetStatusFlag ( FBPlugStatusFlag  pStatus,
bool  pValue 
) [inherited]

Set the plug's status flag.

Parameters:
pStatus bitwise AND of status flags.
pValue true if status has modification.
bool FBPlug::GetStatusFlag ( FBPlugStatusFlag  pStatus ) const [inherited]

Tell if the plug's status has changed.

Parameters:
pStatus bitwise AND of self modification flags.
Returns:
true if self changed
FBPlug* FBPlug::GetOwner ( ) [inherited]

Get the owner of this plug.

Very useful for properties since they are plugs too.

Returns:
The owner of this plug.
FBPlug* FBPlug::GetOwned ( int  pIndex ) [inherited]

Get the owned plug at specified index.

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

Get the owned plug count.

Returns:
The owned plug count.
virtual bool FBPlug::PlugDataNotify ( FBConnectionAction  pAction,
FBPlug pThis,
void *  pData = NULL,
void *  pDataOld = NULL,
int  pDataSize = 0 
) [virtual, inherited]

PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pData Current data, meaning depends of plug action.
pDataOld Previous data, meaning depends of plug action.
pDataSize Size of data.
Returns:
unused should return true
virtual bool FBPlug::PlugStateNotify ( FBConnectionAction  pAction,
FBPlug pThis,
void *  pData = NULL,
void *  pDataOld = NULL,
int  pDataSize = 0 
) [virtual, inherited]

PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pData Current data, meaning depends of plug action.
pDataOld Previous data, meaning depends of plug action.
pDataSize Size of data.
Returns:
unused should return true except in the case of property rename kFBRename
virtual bool FBPlug::PlugNotify ( FBConnectionAction  pAction,
FBPlug pThis,
int  pIndex,
FBPlug pPlug = NULL,
FBConnectionType  pConnectionType = kFBConnectionTypeNone,
FBPlug pNewPlug = NULL 
) [virtual, inherited]

PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pIndex Index of the plug.
pPlug Other plug concerned.
pConnectionType Connection type between the plugs.
pNewPlug New plug (for the replace event).
Returns:
should by default return true except in the case of connection requests (kFBRequestConnectSrc or kFBRequestConnectDst)
static void FBPlug::PrintClassDefinitions ( ) [static, inherited]

Print out internal Class (ID) Definition table.

For internal debug purpose only.

FBScriptWrapper* FBWrapperHolder::GetWrapper ( ) [inherited]

Return the wrapper interface of this FBObject.

void FBWrapperHolder::AddWrapper ( FBScriptWrapper ) [inherited]
void FBWrapperHolder::RemoveWrapper ( FBScriptWrapper ) [inherited]

Friends And Related Function Documentation

K_DLLIMPORT friend int __FBRegisterTypeInfo ( int  pInternalClassId ) [friend, inherited]

__FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.


Member Data Documentation

FBPropertySurfaceType FBPatch::USurfaceType

Read Write Property: Patch mode for U direction.

Definition at line 995 of file fbgeometry.h.

FBPropertySurfaceType FBPatch::VSurfaceType

Read Write Property: Patch mode for V direction.

Definition at line 996 of file fbgeometry.h.

Read Write Property: Size in U directions.

Definition at line 848 of file fbgeometry.h.

Read Write Property: Size in V directions.

Definition at line 849 of file fbgeometry.h.

Read Write Property: Step in U directions.

Definition at line 850 of file fbgeometry.h.

Read Write Property: Step in V directions.

Definition at line 851 of file fbgeometry.h.

Read Write Property: U Closed.

Definition at line 852 of file fbgeometry.h.

Read Write Property: V Closed

Definition at line 853 of file fbgeometry.h.

FBPropertySurfaceMode FBSurface::SurfaceMode [inherited]

Read Write Property: Surface mode.

Definition at line 854 of file fbgeometry.h.

FBPropertyGeometryMappingMode FBGeometry::NormalMappingMode [inherited]

Read Only Property: Normal mapping mode.

Definition at line 412 of file fbgeometry.h.

FBPropertyGeometryReferenceMode FBGeometry::NormalReferenceMode [inherited]

Read Only Property: Normal reference mode.

Definition at line 413 of file fbgeometry.h.

FBPropertyGeometryMappingMode FBGeometry::TangentMappingMode [inherited]

Read Only Property: Tangent mapping mode.

Definition at line 429 of file fbgeometry.h.

FBPropertyGeometryReferenceMode FBGeometry::TangentReferenceMode [inherited]

Read Only Property: Tangent reference mode.

Definition at line 430 of file fbgeometry.h.

FBPropertyGeometryMappingMode FBGeometry::BinormalMappingMode [inherited]

Read Only Property: Binormal mapping mode.

Definition at line 446 of file fbgeometry.h.

FBPropertyGeometryReferenceMode FBGeometry::BinormalReferenceMode [inherited]

Read Only Property: Binormal reference mode.

Definition at line 447 of file fbgeometry.h.

FBPropertyGeometryMappingMode FBGeometry::VertexColorMappingMode [inherited]

Read Only Property: Vertex Color mapping mode.

Definition at line 463 of file fbgeometry.h.

FBPropertyGeometryReferenceMode FBGeometry::VertexColorReferenceMode [inherited]

Read Only Property: Vertex Color reference mode.

Definition at line 464 of file fbgeometry.h.

FBPropertyGeometryMappingMode FBGeometry::MaterialMappingMode [inherited]

Read Property: Material mapping mode.

Definition at line 513 of file fbgeometry.h.

DataFBComponent* FBComponent::mLocalPtr [inherited]

Handle on DataFBComponent.

Reimplemented in FBCustomManager.

Definition at line 650 of file fbcomponent.h.

FBString FBComponent::mName [protected, inherited]

Name of the component.

Definition at line 653 of file fbcomponent.h.

int FBComponent::TypeInfo [static, inherited]

Contains the Type information of the object.

Reimplemented from FBPlug.

Reimplemented in FBCustomManager.

Definition at line 658 of file fbcomponent.h.

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

Definition at line 838 of file fbcomponent.h.

List: List of components.

Reimplemented in FBScene, and FBPropertyInspector.

Definition at line 839 of file fbcomponent.h.

List: Parents.

Definition at line 840 of file fbcomponent.h.

Read Write Property: Selected property.

Definition at line 841 of file fbcomponent.h.

Read Write Property: Unique name of object.

Reimplemented in FBAssetMng, FBConsoleChannel, FBTriggerGroup, FBTrigger, FBMotionClip, and FBTool.

Definition at line 842 of file fbcomponent.h.

Read Write Property: Name and namespace for object.

Definition at line 843 of file fbcomponent.h.

FBPropertyFolder FBComponent::Folder [inherited]

Read Write Property: The folder that contain this component.

Definition at line 846 of file fbcomponent.h.

KObject* FBComponent::mDummyObject [inherited]

Internal Dummy Object for non KObject Components.

Definition at line 871 of file fbcomponent.h.

const char* FBPlug::ClassGroupName [static, inherited]

ClassGroupName of the object.

Definition at line 444 of file fbplug.h.

bool FBPlug::mAllocated [inherited]

Contain the Allocation State of the Component.

Definition at line 450 of file fbplug.h.

int FBPlug::mGlobalTypeInfo [static, protected, inherited]

Represente the Type Index.

Definition at line 500 of file fbplug.h.

HIObject FBPlug::mObject [protected, inherited]

Handle on the Plug.

Definition at line 502 of file fbplug.h.

bool FBPlug::mSDKComponent [protected, inherited]

bool Plug is an SDK component.

Definition at line 503 of file fbplug.h.


The documentation for this class was generated from the following file: