Public Attributes | Protected Member Functions

FbxSelectionSet Class Reference

This reference page is linked to from the following overview topics: List of Python Fbx classes.


Search for all occurrences

Detailed Description

FBX SDK selection set class.

Represents a set of selected objects (FbxObject) and components. This is a non-exclusive (multiple membership) collection. Objects (FbxObject) can be added to a FbxSelectionSet directly, but to add components (vertexes, edges, or faces) you create a selection node (FbxSelectionNode) to group the object and its components together as a single item to be added.

See also:
FbxSelectionNode

Definition at line 30 of file fbxselectionset.h.

#include <fbxselectionset.h>

Inheritance diagram for FbxSelectionSet:
Inheritance graph
[legend]

List of all members.

Public Attributes

FbxPropertyT< FbxStringSelectionSetAnnotation
 This property stores annotation of the selection set.

Protected Member Functions

virtual void ConstructProperties (bool pForceSet)
 Optional property constructor override, automatically called by default constructor.

Utility functions

void GetFaceSelection (FbxObject *pObj, FbxArray< int > &pPolygonIndexArray) const
 Get the selected faces of a specified object.
void GetEdgeSelection (FbxObject *pObj, FbxArray< int > &pEdgeIndexArray) const
 Get the selected edges of a specified object.
void GetVertexSelection (FbxObject *pObj, FbxArray< int > &pVertexIndexArray) const
 Get the selected vertices of a specified object.
void GetSelectionNodesAndDirectObjects (FbxArray< FbxSelectionNode * > &pSelectionNodeList, FbxArray< FbxObject * > &pDirectObjectList) const
 Get list of two types of member in the selection set: SelectionNodes and Directly contained objects.

Member Function Documentation

void GetFaceSelection ( FbxObject pObj,
FbxArray< int > &  pPolygonIndexArray 
) const

Get the selected faces of a specified object.

Parameters:
pObjThe specified object.
pPolygonIndexArrayThe array to take the indices of the selected faces.
Remarks:
The indices of selected faces will be put in pPolygonIndexArray.
void GetEdgeSelection ( FbxObject pObj,
FbxArray< int > &  pEdgeIndexArray 
) const

Get the selected edges of a specified object.

Parameters:
pObjThe specified object.
pEdgeIndexArrayThe array to take the indices of the selected edges.
Remarks:
The indices of selected face will be put in pEdgeIndexArray.
void GetVertexSelection ( FbxObject pObj,
FbxArray< int > &  pVertexIndexArray 
) const

Get the selected vertices of a specified object.

Parameters:
pObjThe specified object.
pVertexIndexArrayThe array to take the indices of the selected vertices.
Remarks:
The indices of selected face will be put in pVertexIndexArray.
void GetSelectionNodesAndDirectObjects ( FbxArray< FbxSelectionNode * > &  pSelectionNodeList,
FbxArray< FbxObject * > &  pDirectObjectList 
) const

Get list of two types of member in the selection set: SelectionNodes and Directly contained objects.

Parameters:
pSelectionNodeListThe array to take selection nodes of the selection set.
pDirectObjectListThe array to take directly contained objects of the selection set.
Remarks:
There might be two types members for a selection set: selection node and directly contained object. They will be listed in pSelectionNodeList and pDirectObjectList separately.
virtual void ConstructProperties ( bool  pForceSet) [protected, virtual]

Optional property constructor override, automatically called by default constructor.

Parameters:
pForceSetIf the property value must be set regardless of default value.
Remarks:
If your object have properties, they must be initialized in this function.

Reimplemented from FbxObject.


Member Data Documentation

This property stores annotation of the selection set.

Default value is "".

Definition at line 38 of file fbxselectionset.h.


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

FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet
FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet FbxSelectionSet