xsi_iceattributedataarray.h

Go to the documentation of this file.

//*****************************************************************************
//*****************************************************************************

#if (_MSC_VER > 1000) || defined(SGI_COMPILER)
#pragma once
#endif

#ifndef __XSIICEATTRIBUTEDATAARRAY_H__
#define __XSIICEATTRIBUTEDATAARRAY_H__

#include <sicppsdk.h>
#include <xsi_iceattribute.h>
#include <xsi_vector2f.h>
#include <xsi_vector3f.h>
#include <xsi_vector4f.h>
#include <xsi_quaternionf.h>
#include <xsi_rotationf.h>
#include <xsi_matrix3f.h>
#include <xsi_matrix4f.h>
#include <xsi_color4f.h>
#include <xsi_shape.h>
#include <xsi_indexset.h>

namespace XSI {

//*****************************************************************************
//*****************************************************************************

class CBaseICEAttributeDataArray
{
public:
    friend class ICEAttribute;

    CBaseICEAttributeDataArray( XSI::siICENodeDataType in_dataType, XSI::siICENodeStructureType in_structType )
        :   m_nCount(0),
            m_bIsConstant(false),
            m_nAccessIndex(UINT_MAX),
            m_nHandle(0),
            m_pData(NULL),
            m_structType( in_structType ),
            m_dataType( in_dataType ),
            m_pParent(NULL)
    {}

    ULONG GetCount() const
    {
        return m_nCount;
    }

    bool IsConstant() const
    {
        return m_bIsConstant;
    }

    XSI::siICENodeDataType GetDataType() const
    {
        return m_dataType;
    }

    XSI::siICENodeStructureType GetStructureType() const
    {
        return m_pParent ? m_pParent->GetStructureType( ) : m_structType;
    }

    virtual ~CBaseICEAttributeDataArray()
    {
        m_attrib.ReleaseDataArray( *this );
    }

protected:
    const void* GetDataPtr( ) const
    {
        return (const void*)m_pData;
    }

    ULONG GetHandle() const
    {
        return m_pParent ? m_pParent->GetHandle( ) : m_nHandle;
    }

    ULONG GetAccessIndex() const
    {
        return m_pParent ? m_pParent->GetAccessIndex( ) : m_nAccessIndex;
    }

    void*& GetDataRef( )
    {
        return m_pData;
    }

    ULONG& GetHandleRef()
    {
        return m_nHandle;
    }

    ULONG& GetCountRef()
    {
        return m_nCount;
    }

    ICEAttribute& GetICEAttributeRef()
    {
        return m_attrib;
    }

    CBitsetHelper& GetBitsetRef()
    {
        return m_bitset;
    }

    bool& GetConstantRef()
    {
        return m_bIsConstant;
    }

    void SetParent( CBaseICEAttributeDataArray* in_pParent )
    {
        m_pParent = in_pParent;
    }

    ULONG& GetAccessIndexRef()
    {
        return m_nAccessIndex;
    }

protected:
    CStatus GetSubDataArray( ULONG in_index, CBaseICEAttributeDataArray& out_dataArray ) const
    {
        CStatus st = m_attrib.GetSubDataArray( (CBaseICEAttributeDataArray&)*this, in_index, out_dataArray );
        assert( st == CStatus::OK );
        return st;
    }

    CStatus GetCustomTypeData( ULONG in_nIndex, const unsigned char** out_ppData, ULONG& out_nSize ) const
    {
        if ( GetStructureType() == XSI::siICENodeStructureSingle )
        {
            return m_attrib.GetCustomTypeData( (CBaseICEAttributeDataArray&)*this, in_nIndex, out_ppData, out_nSize );
        }
        return m_attrib.GetCustomTypeData2D( (CBaseICEAttributeDataArray&)*this, in_nIndex, out_ppData, out_nSize );
    }

    CStatus GetStringData( ULONG in_nIndex, const wchar_t** out_ppData, ULONG& out_nSize ) const
    {
        if ( GetStructureType() == XSI::siICENodeStructureSingle )
        {
            return m_attrib.GetStringData( (CBaseICEAttributeDataArray&)*this, in_nIndex, out_ppData, out_nSize );
        }
        return m_attrib.GetStringData2D( (CBaseICEAttributeDataArray&)*this, in_nIndex, out_ppData, out_nSize );
    }

    ULONG           m_nCount;
    CBitsetHelper   m_bitset;
    bool            m_bIsConstant;

private:
    ULONG                       m_nAccessIndex;
    ULONG                       m_nHandle;
    void*                       m_pData;
    XSI::siICENodeStructureType m_structType;
    XSI::siICENodeDataType      m_dataType;
    ICEAttribute                m_attrib;
    CBaseICEAttributeDataArray* m_pParent;
};

//*****************************************************************************
//*****************************************************************************
template<class T>
class CICEAttributeDataArray : public CBaseICEAttributeDataArray
{
public:

    CICEAttributeDataArray( ) : CBaseICEAttributeDataArray( GetDefaultType( ), XSI::siICENodeStructureSingle ) {}

    ~CICEAttributeDataArray( ) {}

    const T& operator[]( ULONG in_index ) const
    {
        const T* pData = (const T*)GetDataPtr();
        assert( pData != NULL || in_index < GetCount() );

        if (!pData) 
        {
            assert( pData != NULL );
            static T defVal;
            return defVal;
        }
        
        if (m_bIsConstant) 
        {
            return *pData;
        }
        
        return pData[in_index];     
    }

private:
    static XSI::siICENodeDataType GetDefaultType( );

};

//*****************************************************************************
// NB: Do not use the Doxygen \class tag for this template!!!
//*****************************************************************************
template<>
class CICEAttributeDataArray<bool> : public CBaseICEAttributeDataArray
{
public:
    CICEAttributeDataArray<bool>( ) :
        CBaseICEAttributeDataArray( GetDefaultType( ), XSI::siICENodeStructureSingle )
    {}

    ~CICEAttributeDataArray<bool>( ) {}

    const bool operator[]( ULONG in_index ) const
    {
        return m_bitset.GetBit( in_index );
    }

private:
    static SICPPSDK_INLINE XSI::siICENodeDataType GetDefaultType( )
    {
        return siICENodeDataBool;
    }
};

//*****************************************************************************
//*****************************************************************************

class CICEAttributeDataArrayCustomType : public CBaseICEAttributeDataArray
{
    public:
    typedef unsigned char TData;

    SICPPSDK_INLINE CICEAttributeDataArrayCustomType( ) : CBaseICEAttributeDataArray( GetDefaultType( ), XSI::siICENodeStructureSingle )
    {}

    SICPPSDK_INLINE ~CICEAttributeDataArrayCustomType( )
    {}

    SICPPSDK_INLINE CStatus GetData( ULONG in_nIndex, const TData** out_ppData, ULONG& out_nSize  ) const;

private:
    static SICPPSDK_INLINE XSI::siICENodeDataType GetDefaultType( )
    {
        return siICENodeDataCustomType;
    }
};

CStatus CICEAttributeDataArrayCustomType::GetData( ULONG in_nIndex, const TData** out_ppData, ULONG& out_nSize  ) const
{
    return GetCustomTypeData( in_nIndex, out_ppData, out_nSize );
}

//*****************************************************************************
//*****************************************************************************

class CICEAttributeDataArrayString : public CBaseICEAttributeDataArray
{
    public:
    typedef wchar_t TData;

    SICPPSDK_INLINE CICEAttributeDataArrayString( ) : CBaseICEAttributeDataArray( GetDefaultType( ), XSI::siICENodeStructureSingle )
    {}

    SICPPSDK_INLINE ~CICEAttributeDataArrayString( )
    {}

    SICPPSDK_INLINE CStatus GetData( ULONG in_nIndex, const TData** out_ppStr, ULONG& out_nCount ) const;

    SICPPSDK_INLINE CStatus GetData( ULONG in_nIndex, CString& out_str ) const;

    SICPPSDK_INLINE CString operator[]( ULONG in_nIndex ) const;

private:
    static SICPPSDK_INLINE XSI::siICENodeDataType GetDefaultType( )
    {
        return siICENodeDataString;
    }
};

CStatus CICEAttributeDataArrayString::GetData( ULONG in_nIndex, const TData** out_ppStr, ULONG& out_nCount ) const
{
    return GetStringData( in_nIndex, out_ppStr, out_nCount );
}

SICPPSDK_INLINE CStatus CICEAttributeDataArrayString::GetData( ULONG in_nIndex, CString& out_str ) const
{
    const wchar_t* pzStr;
    ULONG nSize;
    CStatus st = GetStringData( in_nIndex, &pzStr, nSize );
    out_str = CString( pzStr, nSize );
    return st;
}

SICPPSDK_INLINE CString CICEAttributeDataArrayString::operator[]( ULONG i ) const
{
    CString str;
    GetData( i, str );
    return str;
}

typedef XSI::CICEAttributeDataArray< float > CICEAttributeDataArrayFloat;
typedef XSI::CICEAttributeDataArray< LONG > CICEAttributeDataArrayLong;
typedef XSI::CICEAttributeDataArray< bool > CICEAttributeDataArrayBool;
typedef XSI::CICEAttributeDataArray< XSI::MATH::CVector2f > CICEAttributeDataArrayVector2f;
typedef XSI::CICEAttributeDataArray< XSI::MATH::CVector3f > CICEAttributeDataArrayVector3f;
typedef XSI::CICEAttributeDataArray< XSI::MATH::CVector4f > CICEAttributeDataArrayVector4f;
typedef XSI::CICEAttributeDataArray< XSI::MATH::CQuaternionf > CICEAttributeDataArrayQuaternionf;
typedef XSI::CICEAttributeDataArray< XSI::MATH::CRotationf > CICEAttributeDataArrayRotationf;
typedef XSI::CICEAttributeDataArray< XSI::MATH::CMatrix3f > CICEAttributeDataArrayMatrix3f;
typedef XSI::CICEAttributeDataArray< XSI::MATH::CMatrix4f > CICEAttributeDataArrayMatrix4f;
typedef XSI::CICEAttributeDataArray< XSI::MATH::CColor4f > CICEAttributeDataArrayColor4f;
typedef XSI::CICEAttributeDataArray< XSI::MATH::CShape> CICEAttributeDataArrayShape;

template<> SICPPSDK_INLINE XSI::siICENodeDataType CICEAttributeDataArrayFloat::GetDefaultType( ){return siICENodeDataFloat;}
template<> SICPPSDK_INLINE XSI::siICENodeDataType CICEAttributeDataArrayLong::GetDefaultType( ){return siICENodeDataLong;}
template<> SICPPSDK_INLINE XSI::siICENodeDataType CICEAttributeDataArrayVector2f::GetDefaultType( ){return siICENodeDataVector2;}
template<> SICPPSDK_INLINE XSI::siICENodeDataType CICEAttributeDataArrayVector3f::GetDefaultType( ){return siICENodeDataVector3;}
template<> SICPPSDK_INLINE XSI::siICENodeDataType CICEAttributeDataArrayVector4f::GetDefaultType( ){return siICENodeDataVector4;}
template<> SICPPSDK_INLINE XSI::siICENodeDataType CICEAttributeDataArrayQuaternionf::GetDefaultType( ){return siICENodeDataQuaternion;}
template<> SICPPSDK_INLINE XSI::siICENodeDataType CICEAttributeDataArrayMatrix3f::GetDefaultType( ){return siICENodeDataMatrix33;}
template<> SICPPSDK_INLINE XSI::siICENodeDataType CICEAttributeDataArrayMatrix4f::GetDefaultType( ){return siICENodeDataMatrix44;}
template<> SICPPSDK_INLINE XSI::siICENodeDataType CICEAttributeDataArrayColor4f::GetDefaultType( ){return siICENodeDataColor4;}
template<> SICPPSDK_INLINE XSI::siICENodeDataType CICEAttributeDataArrayRotationf::GetDefaultType( ){return siICENodeDataRotation;}
template<> SICPPSDK_INLINE XSI::siICENodeDataType CICEAttributeDataArrayShape::GetDefaultType( ){return siICENodeDataShape;}

};

#endif // __XSIICEATTRIBUTEDATAARRAY_H__