xsi_projectitem.h

Go to the documentation of this file.

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

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

#ifndef __XSIPROJECTITEM_H__
#define __XSIPROJECTITEM_H__

#include <xsi_siobject.h>
#include <xsi_value.h>
#include <xsi_parameter.h>

namespace XSI {

class Model;
class X3DObject;
class PPGLayout;
class ICEAttribute;

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

class SICPPSDKDECL ProjectItem : public SIObject
{
public:
        ProjectItem();

        ~ProjectItem();

        ProjectItem(const CRef& in_ref);

        ProjectItem(const ProjectItem& in_obj);

        bool IsA( siClassID in_ClassID) const;

        siClassID GetClassID() const;

        ProjectItem& operator=(const ProjectItem& in_obj);

        ProjectItem& operator=(const CRef& in_ref);

        CString GetFamilies() const;

        siCapabilities GetCapabilities() const;

        CStatus PutCapabilityFlag( siCapabilities in_flag, bool in_bEnable ) ;


        bool GetSelected
        (
                siBranchFlag in_branchFlag = siNode
        ) const;

        CStatus PutSelected
        (
                bool in_newState,
                siBranchFlag in_branchFlag = siNode
        );

        CRefArray GetOwners() const;

        CParameterRefArray& GetParameters() const;

        Model GetModel() const;

        bool IsRelationship(siPSetRelationship in_PSetRelationship) const;

        bool BelongsTo( const CString& in_family) const;


        bool IsKindOf(const CString& in_objectType) const;

        bool IsAnimated
        (
                siSourceType    in_sourceType = siAnySource,
                bool                    in_bLocal = false
        ) const;

        CRefArray GetAnimatedParameters
        (
                siSourceType    in_sourceType = siAnySource,
                bool                    in_bLocal = false
        ) const;

        CRef EvaluateAt( double in_dFrame = DBL_MAX);

        CStatus PutParameterValue( const CString& in_scriptname, bool in_val, double in_time = DBL_MAX );

        CStatus PutParameterValue( const CString& in_scriptname, double in_val, double in_time = DBL_MAX);

        CStatus PutParameterValue( const CString& in_scriptname, float in_val, double in_time = DBL_MAX );

        CStatus PutParameterValue( const CString& in_scriptname, short in_val, double in_time = DBL_MAX );

        CStatus PutParameterValue( const CString& in_scriptname, LONG in_val, double in_time = DBL_MAX );

        CStatus PutParameterValue( const CString& in_scriptname, LLONG in_val, double in_time = DBL_MAX );

        CStatus PutParameterValue( const CString& in_scriptname, const CValue& in_val, double in_time = DBL_MAX );

        CStatus PutParameterValue( const CString& in_scriptname, const CRef& in_val, double in_time = DBL_MAX );

        CStatus PutParameterValue( const CString& in_scriptname, const CString& in_val, double in_time = DBL_MAX );

        CValue GetParameterValue( const CString& in_scriptname, double in_time=DBL_MAX )const;

        Parameter GetParameter( const CString& in_scriptname ) const;

        PPGLayout GetPPGLayout() const ;

        siLockType GetLockType();
        siLockLevel GetLockLevel();
        bool IsLocked();

        CStatus SetLock(siLockLevel  in_level=siLockLevelAll);

        CStatus UnSetLock(siLockLevel in_level=siLockLevelAll, const CString&in_password=CString() );

        CRefArray GetTaggedParameters
        (
                siTags          in_tags = siTagAll,
                bool            in_bLocal = false
        ) const;

        CRefArray GetLockOwners
        (
                siLockLevel in_eLevel = siLockLevelAll,
                bool            in_bLocal = false
        ) const;

        CRef AddScriptedOp(
                        const CString& in_code=L"",
                        const CRefArray& in_inputs = CRefArray(),
                        const CString& in_name=L"",
                        const CString& in_language=L"",
                        siConstructionMode in_mode = siConstructionModeDefault,
                        CStatus* out_pst = 0 );

        CRef AddScriptedOpFromFile( const CString& in_filename = L"", const CRefArray& in_inputs = CRefArray(), const CString& in_name = L"", const CString& in_language = L"", siConstructionMode in_mode = siConstructionModeDefault, CStatus* out_pst = 0 );

        CRef AddCustomOp(
                        const CString& in_type,
                        const CRefArray& in_inputs = CRefArray(),
                        const CString& in_name=L"",
                        siConstructionMode in_mode = siConstructionModeDefault,
                        CStatus* io_pst = 0 );

        CRefArray GetLockOwners() const;

        X3DObject GetParent3DObject() const;

        siBranchFlag GetBranchFlag() const;

        CRefArray GetICEAttributes() const;

        ICEAttribute GetICEAttributeFromName( const CString& in_name ) const;

        ICEAttribute AddICEAttribute( const CString& in_name, XSI::siICENodeDataType in_DataType, XSI::siICENodeStructureType in_StructureType, XSI::siICENodeContextType in_ContextType );

        CStatus RemoveICEAttribute( const CString& in_name );


        ULONG GetObjectID( ) const;

        LONG    GetEvaluationID();

        LONG    GetHierarchicalEvaluationID();

        protected:
        mutable CParameterRefArray m_paramArray;

        private:
        ProjectItem * operator&() const;
        ProjectItem * operator&();

};

};

#endif // __XSIPROJECTITEM_H__