Public Attributes | Protected Member Functions

KFbxSelectionSet 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 (KFbxObject) and components. This is a non-exclusive (multiple membership) collection. Objects (KfbxObject) can be added to a KFbxSelectionSet directly, but to add components (vertexes, edges, or faces) you create a selection node (KFbxSelectionNode) to group the object and its components together as a single item to be added.

See also:
KFbxSelectionNode

Definition at line 57 of file kfbxselectionset.h.

#include <kfbxselectionset.h>

Inheritance diagram for KFbxSelectionSet:
Inheritance graph
[legend]

List of all members.

Public Attributes

KFbxTypedProperty< fbxString SelectionSetAnnotation
  This property stores annotation of the selection set.

Protected Member Functions

  KFbxSelectionSet (KFbxSdkManager &pManager, char const *pName)
bool  ConstructProperties (bool pForceSet)

Utility functions

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

Constructor & Destructor Documentation

KFbxSelectionSet ( KFbxSdkManager pManager,
char const *  pName 
) [protected]

Member Function Documentation

void GetFaceSelection ( KFbxObject pObj,
KArrayTemplate< int > &  pPolygonIndexArray 
) const

Get the selected faces of a specified object.

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

Get the selected edges of a specified object.

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

Get the selected vertices of a specified object.

Parameters:
pObj The specified object.
pVertexIndexArray The array to take the indices of the selected vertices.
Remarks:
The indices of selected face will be put in pVertexIndexArray.
void GetSelectionNodesAndDirectObjects ( KArrayTemplate< KFbxSelectionNode * > &  pSelectionNodeList,
KArrayTemplate< KFbxObject * > &  pDirectObjectList 
) const

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

Parameters:
pSelectionNodeList The array to take selection nodes of the selection set.
pDirectObjectList The 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.
bool ConstructProperties ( bool  pForceSet ) [protected, virtual]

Member Data Documentation

This property stores annotation of the selection set.

Default value is "".

Definition at line 65 of file kfbxselectionset.h.


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

KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet
KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet KFbxSelectionSet