XSI::ICEAttribute

ICEAttribute Class Reference

Related Scripting Object: ICEAttribute

The ICEAttribute object represents an attribute data set (a collection of information used in the ICE system, such as Age, PointPosition, NbrPolygons, etc.). More...

#include <xsi_iceattribute.h>

Inheritance diagram for ICEAttribute:

SIObject CBase List of all members.

Public Member Functions
  ICEAttribute ()
  ~ICEAttribute ()
  ICEAttribute (const CRef &in_ref)
  ICEAttribute (const ICEAttribute &in_obj)
bool  IsA (siClassID in_ClassID) const
siClassID  GetClassID () const
ICEAttribute &  operator= (const ICEAttribute &in_obj)
ICEAttribute &  operator= (const CRef &in_ref)
bool  IsDefined () const
bool  IsConstant () const
bool  IsReadonly () const
XSI::siICENodeDataType  GetDataType () const
XSI::siICENodeStructureType  GetStructureType () const
XSI::siICENodeContextType  GetContextType () const
XSI::siICEAttributeCategory  GetAttributeCategory () const
ULONG  GetElementCount () const
CStatus  GetDataArray (CBaseICEAttributeDataArray &io_dataArray) const
CStatus  GetDataArrayChunk (ULONG in_nOffset, ULONG in_nSize, CBaseICEAttributeDataArray &io_dataArray) const
CStatus  GetDataArray2D (CBaseICEAttributeDataArray &io_dataArray) const
CStatus  GetDataArray2DChunk (ULONG in_nOffset, ULONG in_nSize, CBaseICEAttributeDataArray &io_dataArray) const

Detailed Description

The ICEAttribute object represents an attribute data set (a collection of information used in the ICE system, such as Age, PointPosition, NbrPolygons, etc.).

Attribute data sets belong to scene objects such as geometries and properties. Some attributes are built-in, others may be user-defined. ICEAttribute objects can be accessed through Geometry::GetICEAttributes and ProjectItem::GetICEAttributes.

See also:
Geometry::GetICEAttributes, ProjectItem::GetICEAttributes, ICENode, ICETree
Since:
7.0
Example:
This example demonstrates how to log all the ICEAttributes of a geometry. 
    CValue CreatePrim( const CString& in_presetobj, const CString& in_geometrytype, const CString& in_name, const CString& in_parent );

    Application xsi;

    CreatePrim( L"Cone", L"MeshSurface", L"", L"");
    Selection selection = xsi.GetSelection();

    X3DObject cone = selection[0];
    CRefArray attrs = cone.GetActivePrimitive().GetGeometry().GetICEAttributes();

    for( ULONG i = 0; i<attrs.GetCount(); i++ )
    {
        ICEAttribute attr = attrs[i];
        xsi.LogMessage( L"*******************************************************************" );
        xsi.LogMessage( L"Name: " + attr.GetName() );
        xsi.LogMessage( L"DataType: " + CString(attr.GetDataType()) );
        xsi.LogMessage( L"StructType: " + CString(attr.GetStructureType()) );
        xsi.LogMessage( L"ContextType: " + CString(attr.GetContextType()) );
        xsi.LogMessage( L"IsConstant: " + CString(attr.IsConstant()) );
        xsi.LogMessage( L"Readonly: " + CString(attr.IsReadonly()) );
        xsi.LogMessage( L"AttributeCategory: " + CString(attr.GetAttributeCategory()) );
        xsi.LogMessage( L"Element count: " + CString(attr.GetElementCount()) );
    }

    // Helper
    CValue CreatePrim( const CString& in_presetobj, const CString& in_geometrytype, const CString& in_name, const CString& in_parent )
    {
        CValueArray args(4);
        CValue retval;
        args[0]= in_presetobj;
        args[1]= in_geometrytype;
        args[2]= in_name;
        args[3]= in_parent;

        Application app;
        app.ExecuteCommand( L"CreatePrim", args, retval );
        return retval;
    }

Constructor & Destructor Documentation

ICEAttribute (  ) 

Default constructor.

~ICEAttribute (  ) 

Default destructor.

ICEAttribute ( const CRef &  in_ref  ) 

Constructor.

Parameters:
in_ref  constant reference object.

ICEAttribute ( const ICEAttribute &  in_obj  ) 

Copy constructor.

Parameters:
in_obj  constant class object.

Member Function Documentation

bool IsA ( siClassID  in_ClassID  )  const [virtual]

Returns true if a given class type is compatible with this API class.

Parameters:
in_ClassID  class type.
Returns:
true if the class is compatible, false otherwise.

Reimplemented from SIObject.

siClassID GetClassID (  )  const [virtual]

Returns the type of the API class.

Returns:
The class type.

Reimplemented from SIObject.

ICEAttribute& operator= ( const ICEAttribute &  in_obj  ) 

Creates an object from another object. The newly created object is set to empty if the input object is not compatible.

Parameters:
in_obj  constant class object.
Returns:
The new ICEAttribute object.

ICEAttribute& operator= ( const CRef &  in_ref  ) 

Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.

Parameters:
in_ref  constant class object.
Returns:
The new ICEAttribute object.

Reimplemented from SIObject.

bool IsDefined (  )  const

Returns a boolean value indicating whether the data for this attribute is ready to be used (true) or not (false).

Returns:
true if the data has been defined, false otherwise.

bool IsConstant (  )  const

Returns a bool value indicating whether the data for this attribute is constant (true) or not (false).

Returns:
Attribute constant flag.

bool IsReadonly (  )  const

Returns a bool value indicating whether the data for this attribute is read-only (true) or not (false).

Returns:
Attribute read-only flag.

XSI::siICENodeDataType GetDataType (  )  const

Returns the type for this attribute data as an siICENodeDataType value.

Returns:
Attribute data type.

XSI::siICENodeStructureType GetStructureType (  )  const

Returns the type for this attribute data as an siICENodeStructureType value. The returned type identifies how the data is structured: data can be a single element or an array.

Returns:
Attribute data structure type.

XSI::siICENodeContextType GetContextType (  )  const

Returns the context type of this attribute data as an siICENodeContextType value. The returned type identifies the element set associated with the data (cardinality), such as vertices, polygons, or newly created particles.

Returns:
Attribute data context type.

XSI::siICEAttributeCategory GetAttributeCategory (  )  const

Returns the category as an siICEAttributeCategory value describing how the attribute is defined.

Returns:
Attribute category type.

ULONG GetElementCount (  )  const

Returns the number of elements defined for this attribute given its context type siICENodeContextType.

Returns:
Number of elements.
See also:
ICEAttribute::GetContextType

CStatus GetDataArray ( CBaseICEAttributeDataArray &  io_dataArray  )  const

Returns a read-only CBaseICEAttributeDataArray object containing the data defined by this attribute. Returns an empty array if the attribute's structure type is not a singleton.

Parameters:
io_dataArray  Newly created array of ICEAttribute data.
Returns:
CStatus::OK Success.

CStatus::False Attribute has no data set yet.

CStatus::InvalidArgument io_dataArray is invalid. This is typically caused by an invalid type match between io_dataArray and this ICEAttribute.

CStatus::Fail Operation failed.

Example:
This example shows how to access all attribute data on a geometry. 
        CValue CreatePrim( const CString& in_presetobj, const CString& in_geometrytype, const CString& in_name, const CString& in_parent );

        template < class T >
        class CICEAttributeDataLogger
        {
            public:
            static void Log( ICEAttribute& attr )
            {
                CICEAttributeDataArray< T > data;
                attr.GetDataArray( data );

                Application xsi;
                for( ULONG i=0; i<data.GetCount( ); i++ )
                {
                    xsi.LogMessage( CString( data[ i ] ) );
                }
            }
        };

        Application xsi;

        CreatePrim( L"Cone", L"MeshSurface", L"", L"");
        Selection selection = xsi.GetSelection();

        X3DObject cone = selection[0];
        CRefArray attrs = cone.GetActivePrimitive().GetGeometry().GetICEAttributes();

        for( ULONG i = 0; i<attrs.GetCount(); i++ )
        {
            ICEAttribute attr = attrs[i];
            xsi.LogMessage( L"*******************************************************************" );
            xsi.LogMessage( L"Name: " + attr.GetName() );
            xsi.LogMessage( L"DataType: " + CString(attr.GetDataType()) );
            xsi.LogMessage( L"StructType: " + CString(attr.GetStructureType()) );
            xsi.LogMessage( L"ContextType: " + CString(attr.GetContextType()) );
            xsi.LogMessage( L"IsConstant: " + CString(attr.IsConstant()) );
            xsi.LogMessage( L"Readonly: " + CString(attr.IsReadonly()) );
            xsi.LogMessage( L"AttributeCategory: " + CString(attr.GetAttributeCategory()) );
            xsi.LogMessage( L"Element count: " + CString(attr.GetElementCount()) );

            if ( attr.GetStructureType() != XSI::siICENodeStructureSingle )
            {
                // Only process 1D array data
                continue;
            }

            switch( attr.GetDataType() )
            {
                case XSI::siICENodeDataFloat: CICEAttributeDataLogger<float>::Log( attr ); break;
                case XSI::siICENodeDataLong: CICEAttributeDataLogger<LONG>::Log( attr ); break;
                case XSI::siICENodeDataBool: CICEAttributeDataLogger<bool>::Log( attr ); break;
                case XSI::siICENodeDataVector2: CICEAttributeDataLogger<XSI::MATH::CVector2f>::Log( attr ); break;
                case XSI::siICENodeDataVector3: CICEAttributeDataLogger<XSI::MATH::CVector3f>::Log( attr ); break;
                case XSI::siICENodeDataVector4: CICEAttributeDataLogger<XSI::MATH::CVector4f>::Log( attr ); break;
                case XSI::siICENodeDataQuaternion: CICEAttributeDataLogger<XSI::MATH::CQuaternionf>::Log( attr ); break;
                case XSI::siICENodeDataRotation: CICEAttributeDataLogger<XSI::MATH::CRotationf>::Log( attr ); break;
                case XSI::siICENodeDataMatrix33: CICEAttributeDataLogger<XSI::MATH::CMatrix3f>::Log( attr ); break;
                case XSI::siICENodeDataMatrix44: CICEAttributeDataLogger<XSI::MATH::CMatrix4f>::Log( attr ); break;
                case XSI::siICENodeDataColor4: CICEAttributeDataLogger<XSI::MATH::CColor4f>::Log( attr ); break;
            };
        }

        // Helper
        CValue CreatePrim( const CString& in_presetobj, const CString& in_geometrytype, const CString& in_name, const CString& in_parent )
        {
            CValueArray args(4);
            CValue retval;
            args[0]= in_presetobj;
            args[1]= in_geometrytype;
            args[2]= in_name;
            args[3]= in_parent;

            Application app;
            app.ExecuteCommand( L"CreatePrim", args, retval );
            return retval;
        }
See also:
ICEAttribute::GetStructureType

CStatus GetDataArrayChunk ( ULONG  in_nOffset,
ULONG  in_nSize,
CBaseICEAttributeDataArray &  io_dataArray  
) const

Returns a read-only CBaseICEAttributeDataArray object containing the data defined by this attribute. The data can be accessed in multiple chunks given an index offset that refers to the attribute's global data buffer and a chunk size. GetDataArrayChunk is particularly useful for minimizing the memory allocation required to store the data retrieved from a very large data set. An empty array is returned if the attribute's structure type is not a singleton.

Parameters:
in_nOffset  Index offset into the attribute data buffer.
in_nSize  Size of chunk to gather.
io_dataArray  Newly created array of ICEAttribute data.
Returns:
CStatus::OK Success.

CStatus::False Attribute has no data set yet.

CStatus::Fail Operation failed.

Example:
This example shows how to access all attribute data of a geometry in chunk. 
        CValue CreatePrim( const CString& in_presetobj, const CString& in_geometrytype, const CString& in_name, const CString& in_parent )

        template < class T >
        class CICEAttributeDataChunkLogger
        {
            public:
            static void Log( ICEAttribute& attr, ULONG in_nOffset, ULONG in_nSize )
            {
                CICEAttributeDataArray< T > data;
                attr.GetDataArrayChunk( in_nOffset, in_nSize, data );

                Application xsi;
                xsi.LogMessage( L"Chunk size: " + CString(data.GetCount( )) );
                for( ULONG i=0; i<data.GetCount( ); i++ )
                {
                    xsi.LogMessage( CString( data[ i ] ) );
                }
            }
        };

        Application xsi;

        CreatePrim( L"Cone", L"MeshSurface", L"", L"");
        Selection selection = xsi.GetSelection();

        X3DObject cone = selection[0];
        CRefArray attrs = cone.GetActivePrimitive().GetGeometry().GetICEAttributes();

        ULONG nChunkCount = 4;
        for( ULONG i = 0; i<attrs.GetCount(); i++ )
        {
            ICEAttribute attr = attrs[i];

            if ( attr.GetStructureType() != XSI::siICENodeStructureSingle )
            {
                // Only process 1D array data
                continue;
            }

            xsi.LogMessage( L"*******************************************************************" );
            xsi.LogMessage( L"Name: " + attr.GetName() );
            xsi.LogMessage( L"DataType: " + CString(attr.GetDataType()) );
            xsi.LogMessage( L"StructType: " + CString(attr.GetStructureType()) );
            xsi.LogMessage( L"ContextType: " + CString(attr.GetContextType()) );
            xsi.LogMessage( L"IsConstant: " + CString(attr.IsConstant()) );
            xsi.LogMessage( L"Readonly: " + CString(attr.IsReadonly()) );
            xsi.LogMessage( L"AttributeCategory: " + CString(attr.GetAttributeCategory()) );
            xsi.LogMessage( L"Element count: " + CString(attr.GetElementCount()) );

            //  Compute the chunk vector to access the data
            ULONG nChunkSize = attr.GetElementCount() / nChunkCount;
            ULONG nLastChunk = attr.GetElementCount()  % nChunkCount;

            CLongArray nChunks;
            for( ULONG iChunk = 0; iChunk < nChunkCount; iChunk++ )
            {
                nChunks.Add( nChunkSize );
            }
            nChunks.Add( nLastChunk );

            ULONG nOffset = 0;

            for ( ULONG j=0; j<nChunks.GetCount(); j++ )
            {
                ULONG nChunkSize = nChunks[j];
                if ( nChunkSize == 0 )
                {
                    continue;
                }

                switch( attr.GetDataType() )
                {
                    case XSI::siICENodeDataFloat: CICEAttributeDataChunkLogger<float>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataLong: CICEAttributeDataChunkLogger<LONG>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataBool: CICEAttributeDataChunkLogger<bool>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataVector2: CICEAttributeDataChunkLogger<XSI::MATH::CVector2f>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataVector3: CICEAttributeDataChunkLogger<XSI::MATH::CVector3f>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataVector4: CICEAttributeDataChunkLogger<XSI::MATH::CVector4f>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataQuaternion: CICEAttributeDataChunkLogger<XSI::MATH::CQuaternionf>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataRotation: CICEAttributeDataChunkLogger<XSI::MATH::CRotationf>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataMatrix33: CICEAttributeDataChunkLogger<XSI::MATH::CMatrix3f>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataMatrix44: CICEAttributeDataChunkLogger<XSI::MATH::CMatrix4f>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataColor4: CICEAttributeDataChunkLogger<XSI::MATH::CColor4f>::Log( attr, nOffset, nChunkSize ); break;
                };

                nOffset += nChunkSize;
            }
        }

        // Helper
        CValue CreatePrim( const CString& in_presetobj, const CString& in_geometrytype, const CString& in_name, const CString& in_parent )
        {
            CValueArray args(4);
            CValue retval;
            args[0]= in_presetobj;
            args[1]= in_geometrytype;
            args[2]= in_name;
            args[3]= in_parent;

            Application app;
            app.ExecuteCommand( L"CreatePrim", args, retval );
            return retval;
        }
See also:
ICEAttribute::GetStructureType

CStatus GetDataArray2D ( CBaseICEAttributeDataArray &  io_dataArray  )  const

Returns a read-only CBaseICEAttributeDataArray2D object containing the 2D data defined by this attribute. Returns an empty array if the attribute's structure type is not a 2D array.

Parameters:
io_dataArray  Newly created array of ICEAttribute data.
Returns:
CStatus::OK Success.

CStatus::False Attribute has no data set yet.

CStatus::Fail Operation failed.

Example:
This example shows how to access all attribute data of an envelope weight property. 
    CValue CreatePrim( const CString& in_presetobj, const CString& in_geometrytype, const CString& in_name, const CString& in_parent );
    CValue Create2DSkeleton( const CValue& in_rx, const CValue& in_ry, const CValue& in_rz, const CValue& in_ex, const CValue& in_ey, const CValue& in_ez, const CValue& in_nx, const CValue& in_ny, const CValue& in_nz, const CValue& in_viewtype,  CValue& out_bone,  CValue& out_effector );
    CValue AppendBone( const CValue&  in_inputobjs, const CValue& in_ex, const CValue& in_ey, const CValue& in_ez, bool in_pin );
    CValue ApplyFlexEnv( const CValue&  in_connectionset, bool in_assignnewdeformers,  XSI::siConstructionMode & io_constructionmode );
    void SelectObj( const CValue&  in_selectionlist, const CString& in_hierarchylevel, bool in_checkobjectselectability ) ;

    template < class T >
    class CICEAttributeData2DLogger
    {
        public:
        static void Log( ICEAttribute& attr )
        {
            CICEAttributeDataArray2D< T > data2D;
            attr.GetDataArray2D( data2D );

            Application xsi;
            for( ULONG i=0; i<data2D.GetCount( ); i++ )
            {
                CICEAttributeDataArray< T > data;
                data2D.GetSubArray( i, data );
                for( ULONG j=0; j<data.GetCount( ); j++ )
                {
                    xsi.LogMessage( CString( data[ j ] ) );
                }
            }
        }
    };

    Application xsi;

    X3DObject cone = CreatePrim( L"Cone", L"MeshSurface", L"", L"");
    Create2DSkeleton( 2.95, 3.34, -0.33, 4.73, 0.0, 0.0, -5.71, 0, 0, 4, CValue(""), CValue(""));
    AppendBone( L"eff", 3.70, -3.02, 0.30, L"");

    XSI::siConstructionMode mode = siConstructionModeModeling;
    ApplyFlexEnv( L"cone;bone,bone1,eff", true, mode );
    SelectObj( L"cone.polymsh.cls.EnvelopWeightCls.Envelope_Weights", L"", L"" );

    cone.GetActivePrimitive().GetGeometry(0);
    ProjectItem EnvProp = xsi.GetSelection()[0];

    CRefArray attrs = EnvProp.GetICEAttributes();

    for( ULONG i = 0; i<attrs.GetCount(); i++ )
    {
        ICEAttribute attr = attrs[i];

        if ( attr.GetStructureType() != XSI::siICENodeStructureArray )
        {
            // Only process 2D array data
            continue;
        }

        xsi.LogMessage( L"*******************************************************************" );
        xsi.LogMessage( L"Name: " + attr.GetName() );
        xsi.LogMessage( L"DataType: " + CString(attr.GetDataType()) );
        xsi.LogMessage( L"StructType: " + CString(attr.GetStructureType()) );
        xsi.LogMessage( L"ContextType: " + CString(attr.GetContextType()) );
        xsi.LogMessage( L"IsConstant: " + CString(attr.IsConstant()) );
        xsi.LogMessage( L"Readonly: " + CString(attr.IsReadonly()) );
        xsi.LogMessage( L"AttributeCategory: " + CString(attr.GetAttributeCategory()) );
        xsi.LogMessage( L"Element count: " + CString(attr.GetElementCount()) );

        switch( attr.GetDataType() )
        {
            case XSI::siICENodeDataFloat: CICEAttributeData2DLogger<float>::Log( attr ); break;
            case XSI::siICENodeDataLong: CICEAttributeData2DLogger<LONG>::Log( attr ); break;
            case XSI::siICENodeDataBool: CICEAttributeData2DLogger<bool>::Log( attr ); break;
            case XSI::siICENodeDataVector2: CICEAttributeData2DLogger<XSI::MATH::CVector2f>::Log( attr ); break;
            case XSI::siICENodeDataVector3: CICEAttributeData2DLogger<XSI::MATH::CVector3f>::Log( attr ); break;
            case XSI::siICENodeDataVector4: CICEAttributeData2DLogger<XSI::MATH::CVector4f>::Log( attr ); break;
            case XSI::siICENodeDataQuaternion: CICEAttributeData2DLogger<XSI::MATH::CQuaternionf>::Log( attr ); break;
            case XSI::siICENodeDataRotation: CICEAttributeData2DLogger<XSI::MATH::CRotationf>::Log( attr ); break;
            case XSI::siICENodeDataMatrix33: CICEAttributeData2DLogger<XSI::MATH::CMatrix3f>::Log( attr ); break;
            case XSI::siICENodeDataMatrix44: CICEAttributeData2DLogger<XSI::MATH::CMatrix4f>::Log( attr ); break;
            case XSI::siICENodeDataColor4: CICEAttributeData2DLogger<XSI::MATH::CColor4f>::Log( attr ); break;
        };
    }

    // Helpers
    CValue CreatePrim( const CString& in_presetobj, const CString& in_geometrytype, const CString& in_name, const CString& in_parent )
    {
        CValueArray args(4);
        CValue retval;
        args[0]= in_presetobj;
        args[1]= in_geometrytype;
        args[2]= in_name;
        args[3]= in_parent;

        Application app;
        app.ExecuteCommand( L"CreatePrim", args, retval );
        return retval;
    }

    CValue Create2DSkeleton( const CValue& in_rx, const CValue& in_ry, const CValue& in_rz, const CValue& in_ex, const CValue& in_ey, const CValue& in_ez, const CValue& in_nx, const CValue& in_ny, const CValue& in_nz, const CValue& in_viewtype,  CValue& out_bone,  CValue& out_effector )
    {
        CValueArray args(12);
        CValue retval;

        args[0]= in_rx;
        args[1]= in_ry;
        args[2]= in_rz;
        args[3]= in_ex;
        args[4]= in_ey;
        args[5]= in_ez;
        args[6]= in_nx;
        args[7]= in_ny;
        args[8]= in_nz;
        args[9]= in_viewtype;

        Application app;
        app.ExecuteCommand( L"Create2DSkeleton", args, retval );

        out_bone = args[10];
        out_effector = args[11];
        return retval;
    }

    CValue AppendBone( const CValue&  in_inputobjs, const CValue& in_ex, const CValue& in_ey, const CValue& in_ez, bool in_pin )
    {
        CValueArray args(5);
        CValue retval;

        args[0]= in_inputobjs;
        args[1]= in_ex;
        args[2]= in_ey;
        args[3]= in_ez;
        args[4]= in_pin;

        Application app;
        app.ExecuteCommand( L"AppendBone", args, retval );

        return retval;
    }

    CValue ApplyFlexEnv( const CValue&  in_connectionset, bool in_assignnewdeformers,  XSI::siConstructionMode & io_constructionmode )
    {
        CValueArray args(3);
        CValue retval;

        args[0]= in_connectionset;
        args[1]= in_assignnewdeformers;
        args[2]= io_constructionmode;

        Application app;
        app.ExecuteCommand( L"ApplyFlexEnv", args, retval );

        io_constructionmode = (XSI::siConstructionMode)(LONG)args[2];
        return retval;
    }

    void SelectObj( const CValue&  in_selectionlist, const CString& in_hierarchylevel, bool in_checkobjectselectability )
    {
        CValueArray args(3);
        CValue retval;
        args[0]= in_selectionlist;
        args[1]= in_hierarchylevel;
        args[2]= in_checkobjectselectability;

        Application app;

        CStatus st = app.ExecuteCommand( L"SelectObj", args, retval );
        return;
    }
See also:
ICEAttribute::GetStructureType

CStatus GetDataArray2DChunk ( ULONG  in_nOffset,
ULONG  in_nSize,
CBaseICEAttributeDataArray &  io_dataArray  
) const

Returns a read-only CBaseICEAttributeDataArray2D object containing the 2D data defined by this attribute. The data can be accessed in multiple chunks given an index offset that refers to the attribute's global data buffer and a chunk size. GetDataArray2DChunk is particularly useful for minimizing the memory allocation required to store the data retrieved from a very large data set. An empty array is returned if the attribute's structure type is not a 2D array.

Parameters:
in_nOffset  Index offset into the attribute data buffer.
in_nSize  Size of chunk to gather.
io_dataArray  Newly created array of ICEAttribute data.
Returns:
CStatus::OK Success.

CStatus::False Attribute has no data set yet.

CStatus::Fail Operation failed.

Example:
This example shows how to access all attribute data of an envelope weight property. 
        CValue CreatePrim( const CString& in_presetobj, const CString& in_geometrytype, const CString& in_name, const CString& in_parent )
        CValue Create2DSkeleton( const CValue& in_rx, const CValue& in_ry, const CValue& in_rz, const CValue& in_ex, const CValue& in_ey, const CValue& in_ez, const CValue& in_nx, const CValue& in_ny, const CValue& in_nz, const CValue& in_viewtype,  CValue& out_bone,  CValue& out_effector );
        CValue AppendBone( const CValue&  in_inputobjs, const CValue& in_ex, const CValue& in_ey, const CValue& in_ez, bool in_pin );
        CValue ApplyFlexEnv( const CValue&  in_connectionset, bool in_assignnewdeformers,  XSI::siConstructionMode & io_constructionmode );
        void SelectObj( const CValue&  in_selectionlist, const CString& in_hierarchylevel, bool in_checkobjectselectability ) ;

        template < class T >
        class CICEAttributeDataChunk2DLogger
        {
            public:
            static void Log( ICEAttribute& attr, ULONG in_nOffset, ULONG in_nSize )
            {
                CICEAttributeDataArray2D< T > data2D;
                attr.GetDataArray2DChunk( in_nOffset, in_nSize, data2D );

                Application xsi;
                xsi.LogMessage( L"Chunk size: " + CString(data2D.GetCount( )) );
                for( ULONG i=0; i<data2D.GetCount( ); i++ )
                {
                    CICEAttributeDataArray< T > data;
                    data2D.GetSubArray( i, data );
                    for( ULONG j=0; j<data.GetCount( ); j++ )
                    {
                        xsi.LogMessage( CString( data[ j ] ) );
                    }
                }
            }
        };

        Application xsi;

        X3DObject cone = CreatePrim( L"Cone", L"MeshSurface", L"", L"");
        Create2DSkeleton( 2.95, 3.34, -0.33, 4.73, 0.0, 0.0, -5.71, 0, 0, 4, CValue(""), CValue(""));
        AppendBone( L"eff", 3.70, -3.02, 0.30, L"");

        XSI::siConstructionMode mode = siConstructionModeModeling;
        ApplyFlexEnv( L"cone;bone,bone1,eff", true, mode );
        SelectObj( L"cone.polymsh.cls.EnvelopWeightCls.Envelope_Weights", L"", L"" );

        cone.GetActivePrimitive().GetGeometry(0);

        ProjectItem EnvProp = xsi.GetSelection()[0];

        CRefArray attrs = EnvProp.GetICEAttributes();

        ULONG nChunkCount = 4;
        for( ULONG i = 0; i<attrs.GetCount(); i++ )
        {
            ICEAttribute attr = attrs[i];

            if ( attr.GetStructureType() != XSI::siICENodeStructureArray )
            {
                // Only process 2D array data
                continue;
            }

            xsi.LogMessage( L"*******************************************************************" );
            xsi.LogMessage( L"Name: " + attr.GetName() );
            xsi.LogMessage( L"DataType: " + CString(attr.GetDataType()) );
            xsi.LogMessage( L"StructType: " + CString(attr.GetStructureType()) );
            xsi.LogMessage( L"ContextType: " + CString(attr.GetContextType()) );
            xsi.LogMessage( L"IsConstant: " + CString(attr.IsConstant()) );
            xsi.LogMessage( L"Readonly: " + CString(attr.IsReadonly()) );
            xsi.LogMessage( L"AttributeCategory: " + CString(attr.GetAttributeCategory()) );
            xsi.LogMessage( L"Element count: " + CString(attr.GetElementCount()) );

            //  Compute the chunk vector to access the data
            ULONG nChunkSize = attr.GetElementCount() / nChunkCount;
            ULONG nLastChunk = attr.GetElementCount()  % nChunkCount;

            CLongArray nChunks;
            for( ULONG iChunk = 0; iChunk < nChunkCount; iChunk++ )
            {
                nChunks.Add( nChunkSize );
            }
            nChunks.Add( nLastChunk );

            ULONG nOffset = 0;

            for ( ULONG j=0; j<nChunks.GetCount(); j++ )
            {
                ULONG nChunkSize = nChunks[j];
                if ( nChunkSize == 0 )
                {
                    continue;
                }

                switch( attr.GetDataType() )
                {
                    case XSI::siICENodeDataFloat: CICEAttributeDataChunk2DLogger<float>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataLong: CICEAttributeDataChunk2DLogger<LONG>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataBool: CICEAttributeDataChunk2DLogger<bool>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataVector2: CICEAttributeDataChunk2DLogger<XSI::MATH::CVector2f>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataVector3: CICEAttributeDataChunk2DLogger<XSI::MATH::CVector3f>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataVector4: CICEAttributeDataChunk2DLogger<XSI::MATH::CVector4f>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataQuaternion: CICEAttributeDataChunk2DLogger<XSI::MATH::CQuaternionf>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataRotation: CICEAttributeDataChunk2DLogger<XSI::MATH::CRotationf>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataMatrix33: CICEAttributeDataChunk2DLogger<XSI::MATH::CMatrix3f>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataMatrix44: CICEAttributeDataChunk2DLogger<XSI::MATH::CMatrix4f>::Log( attr, nOffset, nChunkSize ); break;
                    case XSI::siICENodeDataColor4: CICEAttributeDataChunk2DLogger<XSI::MATH::CColor4f>::Log( attr, nOffset, nChunkSize ); break;
                };

                nOffset += nChunkSize;
            }
        }

        // Helpers
        CValue CreatePrim( const CString& in_presetobj, const CString& in_geometrytype, const CString& in_name, const CString& in_parent )
        {
            CValueArray args(4);
            CValue retval;
            args[0]= in_presetobj;
            args[1]= in_geometrytype;
            args[2]= in_name;
            args[3]= in_parent;

            Application app;
            app.ExecuteCommand( L"CreatePrim", args, retval );
            return retval;
        }

        CValue Create2DSkeleton( const CValue& in_rx, const CValue& in_ry, const CValue& in_rz, const CValue& in_ex, const CValue& in_ey, const CValue& in_ez, const CValue& in_nx, const CValue& in_ny, const CValue& in_nz, const CValue& in_viewtype,  CValue& out_bone,  CValue& out_effector )
        {
            CValueArray args(12);
            CValue retval;

            args[0]= in_rx;
            args[1]= in_ry;
            args[2]= in_rz;
            args[3]= in_ex;
            args[4]= in_ey;
            args[5]= in_ez;
            args[6]= in_nx;
            args[7]= in_ny;
            args[8]= in_nz;
            args[9]= in_viewtype;

            Application app;
            app.ExecuteCommand( L"Create2DSkeleton", args, retval );

            out_bone = args[10];
            out_effector = args[11];
            return retval;
        }

        CValue AppendBone( const CValue&  in_inputobjs, const CValue& in_ex, const CValue& in_ey, const CValue& in_ez, bool in_pin )
        {
            CValueArray args(5);
            CValue retval;

            args[0]= in_inputobjs;
            args[1]= in_ex;
            args[2]= in_ey;
            args[3]= in_ez;
            args[4]= in_pin;

            Application app;
            app.ExecuteCommand( L"AppendBone", args, retval );

            return retval;
        }

        CValue ApplyFlexEnv( const CValue&  in_connectionset, bool in_assignnewdeformers,  XSI::siConstructionMode & io_constructionmode )
        {
            CValueArray args(3);
            CValue retval;

            args[0]= in_connectionset;
            args[1]= in_assignnewdeformers;
            args[2]= io_constructionmode;

            Application app;
            app.ExecuteCommand( L"ApplyFlexEnv", args, retval );

            io_constructionmode = (XSI::siConstructionMode)(LONG)args[2];
            return retval;
        }

        void SelectObj( const CValue&  in_selectionlist, const CString& in_hierarchylevel, bool in_checkobjectselectability )
        {
            CValueArray args(3);
            CValue retval;
            args[0]= in_selectionlist;
            args[1]= in_hierarchylevel;
            args[2]= in_checkobjectselectability;

            Application app;

            CStatus st = app.ExecuteCommand( L"SelectObj", args, retval );
            return;
        }
See also:
ICEAttribute::GetStructureType

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