FBMesh Class Reference

Mesh class. More...

#include <fbgeometry.h>

Inheritance diagram for FBMesh:

Public Member Functions
	FBMesh (const char *pName, HIObject pObject=NULL)
	Constructor.
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.
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.
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.
int	PolygonBegin (int pMaterialId=0)
	Begin Polygon definition.
bool	PolygonVertexAdd (int pVertex)
	Add a vertex.
int	PolygonEnd ()
	End Polygon definition.
int	PolygonVertexCount (int pPolygonIndex) const
	Get Polygon vertex count.
int	PolygonVertexIndex (int pPolygonIndex, int pVertexPolygonIndex) const
	Get global (for the mesh) index of a vertex from a polygon.
int	PolygonCount () const
	Get number of polygons in mesh.
const int *	PolygonVertexArrayGet (int &pArraySize) const
	Get the array of polygon vertex (i.e.
bool	IsTriangleMesh () const
	Determines if the mesh is composed entirely of triangles.
int	PolygonMaterialIdGet (int pIndex=-1) const
	Get a Material ID for the given Polygon index.
void	ComputeVertexNormals (bool pCW=false)
	Compute Mesh Vertex Normal.
void	InverseNormal ()
	Inverse Normal.
Public Member Functions inherited from FBGeometry
bool	GeometryBegin ()
	Begin geometry editing.
bool	GeometryEnd ()
	End geometry editing.
bool	IsEditingEnabled () const
	Is geometry editing enabled.
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)
	Begin geometry editing.
int	VertexAdd (double px, double py, double pz, double nx, double ny, double nz, double UVu, double UVv)
	Begin geometry editing.
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)
	Begin geometry editing.
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.
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.
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.
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.
void	ModifyNotify (kFBGeometryUpdateFlags pFlags=kFBGeometryUpdateAll, int pFirstIndex=-1, int pLastIndex=-1)
	The geometry has change, update the necessary flags.
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.
Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.
virtual	~FBComponent ()
	Destructor.
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.
virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.
virtual int	GetTypeId () override
	GetTypeId( int pTypeId )
Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.
void	AddWrapper (FBScriptWrapper *)
void	RemoveWrapper (FBScriptWrapper *)

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
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)
Public Attributes inherited from FBGeometry
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.
Public Attributes inherited from FBComponent
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.
Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.
Protected Member Functions inherited from FBGeometry
	FBGeometry (const char *pName, HIObject pObject=NULL)
	Constructor.
Protected Member Functions inherited from FBPlug
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 const char *	ClassName ()
	internal System vars.
virtual bool	Is (int pTypeId)
	Is( int pTypeId )
virtual int	GetTypeId ()
	GetTypeId( int pTypeId )
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.
virtual void	FBDelete ()
	Actual destructor for a FBPlug.
Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.
Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.
HIObject	mObject
	Handle on the Plug.
bool	mSDKComponent
	bool Plug is an SDK component.
Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.
static int	TypeInfo
	TypeInfo.
static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

Mesh class.

Definition at line 644 of file fbgeometry.h.

Constructor & Destructor Documentation

FBMesh()

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

Constructor.

Parameters

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

Member Function Documentation

ComputeVertexNormals()

void ComputeVertexNormals

(

bool

pCW = false

)

Compute Mesh Vertex Normal.

Parameters

pCW	True for clock wise normal, otherwise for counter-clock wise

InverseNormal()

void InverseNormal

(

)

Inverse Normal.

IsTriangleMesh()

bool IsTriangleMesh

(

)

const

Determines if the mesh is composed entirely of triangles.

Returns

true if all polygons are triangles, false otherwise

PolygonBegin()

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

PolygonCount()

int PolygonCount

(

)

const

Get number of polygons in mesh.

Returns

Number of polygons in mesh.

PolygonEnd()

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.

PolygonListAdd()

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.

PolygonMaterialIdGet()

int PolygonMaterialIdGet

(

int

pIndex = -1

)

const

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.

PolygonVertexAdd()

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.

PolygonVertexArrayGet()

const int * PolygonVertexArrayGet

(

int &

pArraySize

)

const

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.

PolygonVertexCount()

int PolygonVertexCount

(

int

pPolygonIndex

)

const

Get Polygon vertex count.

Parameters

pPolygonIndex

Index of polygon to get vertex count from.

Returns

Number of vertices in polygon at pPolygonIndex.

PolygonVertexIndex()

int PolygonVertexIndex	(	int	pPolygonIndex,
		int	pVertexPolygonIndex
	)		const

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.

TriangleListAdd()

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.

TriangleStripAdd()

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.

---

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

• fbgeometry.h