xsi_sceneitem.h

Go to the documentation of this file.

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

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

#ifndef __XSISCENEITEM_H__
#define __XSISCENEITEM_H__

#include <xsi_projectitem.h>
#include <xsi_customproperty.h>
#include <xsi_status.h>

namespace XSI {

class Material;
class Envelope;
class Property;

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

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

    ~SceneItem();

    SceneItem(const CRef& in_ref);

    SceneItem(const SceneItem& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    SceneItem& operator=(const SceneItem& in_obj);

    SceneItem& operator=(const CRef& in_ref);

    CRefArray   GetProperties() const;

    Material    GetMaterial() const;

    CRefArray   GetEnvelopes() const;

    CStatus     ApplyEnvelope
    (
        const CRefArray& in_deformers,
        siBranchFlag     in_DeformOnBranch,
        siBranchFlag     in_EnvOnBranch,
        Envelope&        io_env
    );

    CRefArray   GetLocalProperties() const;

    CStatus     AddMaterial
    (
        const CString&  in_preset,
        bool            in_branch,
        const CString&  in_name,
        Material&       io_mat
    );

    Property AddProperty
    (
        const CString&  in_preset,
        bool            in_bBranch = false,
        const CString&  in_name = CString()
    );

    CStatus     AddProperty
    (
        const CString&  in_preset,
        bool            in_bBranch ,
        const CString&  in_name,
        Property&       out_prop
    );

    CStatus     AddCustomProperty
    (
        const CString&  in_name,
        bool            in_bBranch ,
        CustomProperty& out_customprop
    );

    CStatus     SetMaterial
    (
        Material&       in_Material
    );

    CStatus     GetPropertyFromName
    (
        const CString&  in_name,
        Property&       out_prop
    );

    CStatus     GetLocalPropertyFromName
    (
        const CString&  in_name,
        Property&       out_prop
    );

    private:
    SceneItem * operator&() const;
    SceneItem * operator&();
};

};

#endif // __XSISCENEITEM_H__