xsi_x3dobject.h

Go to the documentation of this file.

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

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

#ifndef __XSIX3DOBJECT_H__
#define __XSIX3DOBJECT_H__

#include <xsi_sceneitem.h>
#include <xsi_status.h>
#include <xsi_math.h>
#include <xsi_nurbsdata.h>

namespace XSI {

class Primitive;
class Kinematics;
class CameraRig;
class LightRig;
class Camera;
class Light;
class Null;
class ChainRoot;
class StaticKinematicState;
class ParticleCloud;
class CMeshBuilder;
class CRigidBodyAccessor;
class CRigidConstraintAccessor;
class Annotation;

//*****************************************************************************
//*****************************************************************************
class SICPPSDKDECL X3DObject : public SceneItem
{
public:
    X3DObject();

    ~X3DObject();

    X3DObject(const CRef& in_ref);

    X3DObject(const X3DObject& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    X3DObject& operator=(const X3DObject& in_obj);

    X3DObject& operator=(const CRef& in_ref);

    CRefArray GetPrimitives() const;

    Primitive GetActivePrimitive() const;

    Primitive GetActivePrimitive( double in_dFrame ) const;

    CRefArray GetChildren() const;

    CRefArray GetModels( bool in_recursive = true) const;

    CRefArray GetMaterials() const;

    Kinematics GetKinematics() const;

    CStatus AddPrimitive
    (
        const CString& in_preset,
        const CString& in_name ,
        X3DObject& io_3dobj
    );

    CStatus AddGeometry
    (
        const CString&  in_geompreset,
        const CString&  in_convpreset,
        const CString&  in_name,
        X3DObject&      io_3dobj
    );

    CStatus AddPolygonMesh( const CString&  in_name,
                            X3DObject&      out_3dobj,
                            CMeshBuilder&   out_meshBuilder );

    CStatus AddPolygonMesh
    (
        const MATH::CVector3Array&  in_vertices,
        const CLongArray&           in_polygonData,
        const CString&              in_name,
        X3DObject&                  io_3dobj
    );

    CStatus AddModel
    (
        const CRefArray&    in_objects,
        const CString&      in_name,
        Model&              io_3dobj
    );

    CStatus AddLattice
    (
        const CString&      in_preset,
        const CRefArray&    in_objects,
        const CString&      in_name,
        X3DObject&          io_3dobj
    );

    CStatus AddControl
    (
        const CString&      in_preset,
        const CRefArray&    in_objects,
        const CString&      in_name,
        X3DObject&          io_3dobj
    );

    CStatus AddCameraRig
    (
        const CString&  in_preset,
        const CString&  in_name,
        CameraRig&      io_rig
    );

    CStatus AddLightRig
    (
        const CString&  in_preset,
        const CString&  in_name,
        LightRig&       io_rig
    );

    CStatus AddCamera
    (
        const CString&  in_preset,
        const CString&  in_name,
        Camera&         io_camera
    );

    CStatus AddLight
    (
        const CString& in_preset,
        bool           in_bInterest,
        const CString& in_name,
        Light&         io_light
    );

    CStatus AddNull
    (
        const CString&  in_name,
        Null&           io_null
    );

    CStatus AddChild
    (
        const CRefArray& in_objects
    );

    CStatus RemoveChild
    (
        const CRefArray& in_objects
    );

    CStatus RemoveFromParent();

    CStatus Add2DChain
    (
        const MATH::CVector3&   in_rootPos,
        const MATH::CVector3&   in_effPos,
        const MATH::CVector3&   in_normPlane,
        si2DChainAlignType      in_alignType,
        const CString&          in_name,
        ChainRoot&              io_chainroot
    );

    CStatus Add3DChain
    (
        const MATH::CVector3&   in_rootPos,
        const MATH::CVector3&   in_effPos,
        const MATH::CVector3&   in_normPlane,
        const CString&          in_name,
        ChainRoot&              io_chainroot
    );

    CRefArray GetShapeAnimatedClusters() const;

    X3DObject FindChild
    (
        const CString&      in_name,
        const CString&      in_type,
        const CStringArray& in_famArray,
        bool                in_bRecursive = true
    ) const;

    X3DObject FindChild2
    (
        const CString&      in_name,
        const CString&      in_type,
        const CStringArray& in_famArray,
        bool                in_bRecursive = true
    ) const;

    CRefArray FindChildren
    (
        const CString&      in_name,
        const CString&      in_type,
        const CStringArray& in_famArray,
        bool                in_bRecursive = true
    ) const;

    CRefArray FindChildren2
    (
        const CString&      in_name,
        const CString&      in_type,
        const CStringArray& in_famArray,
        bool                in_bRecursive = true
    ) const;

    bool HasStaticKinematicState() const;

    StaticKinematicState GetStaticKinematicState() const;

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

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

    CStatus AddNurbsCurve
    (
        const CNurbsCurveData&      in_curveData,
        siNurbsFormat               in_nurbsFormat,
        const CString&              in_name,
        X3DObject&                  io_3dobj
    );

    CStatus AddNurbsCurveList
    (
        const CNurbsCurveDataArray& in_curveDataArray,
        siNurbsFormat               in_nurbsFormat,
        const CString&              in_name,
        X3DObject&                  io_3dobj
    );

    CStatus AddNurbsSurface
    (
        const CNurbsSurfaceData&    in_surfaceData,
        siNurbsFormat               in_nurbsFormat,
        const CString&              in_name,
        X3DObject&                  io_3dobj
    );

    CStatus AddNurbsSurfaceMesh
    (
        const CNurbsSurfaceDataArray&   in_surfaceDataArray,
        siNurbsFormat                   in_nurbsFormat,
        const CString&                  in_name,
        X3DObject&                      io_3dobj
    );

    CStatus AddParticleCloud
    (
        const CRefArray&                in_parTypes,
        const CString&                  in_name,
        ParticleCloud&                  out_particlecloud
    );

    MATH::CVector3 GetLocalScaling()const;

    CStatus PutLocalScaling(MATH::CVector3 in_scaling);


    MATH::CRotation GetLocalRotation()const;

    CStatus PutLocalRotation(MATH::CRotation in_rotation);

    MATH::CVector3 GetLocalTranslation()const;

    CStatus PutLocalTranslation(MATH::CVector3 in_translation);

    CRigidBodyAccessor GetRigidBodyAccessor( ) const;

    CRigidConstraintAccessor GetRigidConstraintAccessor( ) const;

    CStatus GetBoundingBox
    (
       double &                         out_minX,
       double &                         out_minY,
       double &                         out_minZ,
       double &                         out_maxX,
       double &                         out_maxY,
       double &                         out_maxZ,
       const MATH::CTransformation &    in_XfoObjectToBBoxSpace = MATH::CTransformation(),
       bool                             in_bRecursive = false
    ) const;

    Annotation AddAnnotation( const CString& in_text, const CString& in_name = CString() ) ;

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

};

#endif // __XSIX3DOBJECT_H__