#include <xsi_clusterpropertybuilder.h>

Class Description

Provides the services to accelerate the process of creating new cluster properties on a geometry.

The class saves you from creating specific clusters in order to add your properties by creating default clusters. These clusters are reused by the builder when adding subsequent properties. CClusterPropertyBuilder is convenient for importing data in Softimage where performance is critical. All operations performed by the builder are undoable but it is recommended to disable the undo service when using the builder for maximum results.

You use PolygonMesh::GetClusterPropertyBuilder to create an instance of CClusterPropertyBuilder. At creation time the builder automatically freezes all operators currently installed on the geometry. This ensures that subsequent operations for setting the property values will not be affected by any operators that might be installed on existing clusters.

Since:: 5.0

Example:

Adding a vertex color and a weight property with the cluster property builder.

                using namespace XSI;

                Application app;
                Model root = app.GetActiveSceneRoot();

                X3DObject myCube;
                root.AddGeometry( L"Cube", L"MeshSurface",L"myCube",myCube);

                PolygonMesh polymesh = myCube.GetActivePrimitive().GetGeometry();

                CClusterPropertyBuilder cpBuilder = polymesh.GetClusterPropertyBuilder();

                // add a vertex color property on a complete cluster
                ClusterProperty cp = cpBuilder.AddVertexColor();

                // set the vertex color for polygon 0 (nodes 0 1 2 3)
                float colors[] =
                {
                        1.f, 0.f, 0.f, 0.f,
                        0.f, 1.f, 0.f, 0.f,
                        0.f, 0.f, 1.f, 0.f,
                        1.f, 0.f, 1.f, 0.f,
                };

                cp.SetValues( colors, 4 );

                // add a weight map property on vertices 0 2 4 6
                X3DObject myCube2;
                root.AddGeometry( L"Cube", L"MeshSurface", L"myCube2", myCube2 );

                polymesh = myCube2.GetActivePrimitive().GetGeometry();

                cpBuilder = polymesh.GetClusterPropertyBuilder();

                cp = cpBuilder.AddWeightMap(false);


                float weights[] = { .11f, .12f, .13f, .14f };
                LONG elems[] = {0,2,4,6};

                cp.SetValues( elems, weights, 4 );

                CFloatArray wValues;
                cp.GetValues( wValues );
                app.LogMessage( L"Weight element 0: " + CString(wValues[0]) );
                app.LogMessage( L"Weight element 2: " + CString(wValues[2]) );
                app.LogMessage( L"Weight element 4: " + CString(wValues[4]) );
                app.LogMessage( L"Weight element 6: " + CString(wValues[6]) );

                // Expected results:
                // INFO: Weight element 0: 0.11
                // INFO: Weight element 2: 0.12
                // INFO: Weight element 4: 0.13
                // INFO: Weight element 6: 0.14

Inheritance diagram for CClusterPropertyBuilder:

List of all members.

Public Member Functions
	CClusterPropertyBuilder ()
	~CClusterPropertyBuilder ()
	CClusterPropertyBuilder (const CRef &in_ref)
	CClusterPropertyBuilder (const CClusterPropertyBuilder &in_obj)
bool	IsA (siClassID in_ClassID) const
siClassID	GetClassID () const
CClusterPropertyBuilder &	operator= (const CClusterPropertyBuilder &in_obj)
CClusterPropertyBuilder &	operator= (const CRef &in_ref)
CRef	AddUV ()
CRef	AddUV (CString &io_strPropName, CString &io_strClusterName)
CRef	AddUserNormal (bool in_bCompleteCluster=true)
CRef	AddUserNormal (CString &io_strPropName, CString &io_strClusterName, bool in_bCompleteCluster=true)
CRef	AddUserMotion ()
CRef	AddUserMotion (CString &io_strPropName, CString &io_strClusterName)
CRef	AddVertexColor ()
CRef	AddVertexColor (CString &io_strPropName, CString &io_strClusterName)
CRef	AddWeightMap (bool in_bCompleteCluster=true)
CRef	AddWeightMap (CString &io_strPropName, CString &io_strClusterName, bool in_bCompleteCluster=true)
CRef	AddEnvelopeWeight (const CRefArray &in_deformers, bool in_bCompleteCluster=true)
CRef	AddEnvelopeWeight (const CRefArray &in_deformers, CString &io_strPropName, CString &io_strClusterName, bool in_bCompleteCluster=true)
CRef	AddShapeKey (XSI::siShapeReferenceMode in_refMode=XSI::siShapeObjectReferenceMode, bool in_bCompleteCluster=true)
CRef	AddShapeKey (XSI::siShapeReferenceMode in_refMode, CString &io_strPropName, CString &io_strClusterName, bool in_bCompleteCluster=true)
CRef	AddUserDataMap (XSI::siClusterType in_clsType, bool in_bCompleteCluster=true)
CRef	AddUserDataMap (XSI::siClusterType in_clsType, CString &io_strPropName, CString &io_strClusterName, bool in_bCompleteCluster=true)

Constructor & Destructor Documentation

CClusterPropertyBuilder ( )

Default constructor.

~CClusterPropertyBuilder ( )

Default destructor.

CClusterPropertyBuilder ( const CRef & in_ref )

Constructor.

Parameters:

in_ref constant reference object.

CClusterPropertyBuilder ( const CClusterPropertyBuilder & in_obj )

Copy constructor.

Parameters:

in_obj constant class object.

Member Function Documentation

bool IsA ( siClassID in_ClassID ) const [virtual]

CRef AddUV	(	CString &	io_strPropName,
		CString &	io_strClusterName
	)

io_strPropName	The name of the new property to create.
io_strClusterName	The name of a cluster where to add the property.

CRef AddUserNormal	(	CString &	io_strPropName,
		CString &	io_strClusterName,
		bool	in_bCompleteCluster = `true`
	)

CRef AddUserMotion	(	CString &	io_strPropName,
		CString &	io_strClusterName
	)

CRef AddVertexColor	(	CString &	io_strPropName,
		CString &	io_strClusterName
	)

CRef AddWeightMap	(	CString &	io_strPropName,
		CString &	io_strClusterName,
		bool	in_bCompleteCluster = `true`
	)

CRef AddEnvelopeWeight	(	const CRefArray &	in_deformers,
		bool	in_bCompleteCluster = `true`
	)

in_deformers	Array of X3DObject deformers to connect.
in_bCompleteCluster	True if the number of elements of the cluster must match the size of the geometry. Defaults to true.

CRef AddShapeKey	(	XSI::siShapeReferenceMode	in_refMode = `XSI::siShapeObjectReferenceMode`,
		bool	in_bCompleteCluster = `true`
	)

in_refMode	The reference mode for the new shape key to create. All shape keys created on the same cluster must use the same reference mode. The function ensures that all shape keys are created with the reference mode used by the first shape key created on the cluster. Defaults to siShapeObjectReferenceMode.
in_bCompleteCluster	True if the number of elements of the cluster must match the size of the geometry. Defaults to true.

CRef AddShapeKey	(	XSI::siShapeReferenceMode	in_refMode,
		CString &	io_strPropName,
		CString &	io_strClusterName,
		bool	in_bCompleteCluster = `true`
	)

CRef AddUserDataMap	(	XSI::siClusterType	in_clsType,
		bool	in_bCompleteCluster = `true`
	)

in_clsType	The type of the cluster to use.
in_bCompleteCluster	True if the number of elements of the cluster must match the size of the geometry. Defaults to true.

Class Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation