xsi_geometry.h

Go to the documentation of this file.

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

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

#ifndef __XSIGEOMETRY_H__
#define __XSIGEOMETRY_H__

#include <xsi_siobject.h>
#include <xsi_math.h>
#include <xsi_longarray.h>
#include <xsi_doublearray.h>
#include <xsi_cluster.h>
#include <xsi_clusterproperty.h>
#include <xsi_pointlocatordata.h>
#include <xsi_vector3.h>

namespace XSI {

class CFacetRefArray;
class CSegmentRefArray;
class CPointRefArray;
class CSampleRefArray;
class CRefArray;
class CTriangleRefArray;
class ICEAttribute;

namespace MATH {
class CTransformation;
};

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

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

        ~Geometry();

        Geometry(const CRef& in_ref);

        Geometry(const Geometry& in_obj);

        bool IsA( siClassID in_ClassID) const;

        siClassID GetClassID() const;

        Geometry& operator=(const Geometry& in_obj);

        Geometry& operator=(const CRef& in_ref);

        CFacetRefArray          GetFacets() const;

        CSegmentRefArray        GetSegments() const;

        CPointRefArray          GetPoints() const;

        CSampleRefArray         GetSamples() const;

        CRefArray                       GetClusters() const;

        CTriangleRefArray       GetTriangles() const;

        CStatus AddCluster(     const CString& in_type,
                                                const CString& in_name,
                                                const CLongArray& in_indices,
                                                Cluster& io_cluster);

        CStatus AddEmptyCluster(
                                                const CString& in_type,
                                                const CString& in_name,
                                                Cluster& io_cluster);

        PointLocatorData GetSurfacePointLocatorsFromPoints
        (
                LONG in_nbPoints = -1,
                const LONG* in_pPoints = NULL
        ) const;

        PointLocatorData GetClosestLocations
        (
                LONG                    in_nbPositions,
                const double*   in_pPositions
        ) const;

        PointLocatorData GetRaycastIntersections
        (
                LONG                                    in_nbPositions,
                const double*                   in_pPositions,
                const double*                   in_pRays,
                siLineIntersectionType  in_eLineType = siSemiLineIntersection
        ) const;

        PointLocatorData GetClosestLocationsWithinRadius
        (
                const MATH::CVector3&           in_position,
                double                          in_radius,
                LONG                            in_nbToSearch = -1
        ) const;

        CStatus SetupPointLocatorQueries
        (
                siClosestLocationMethod in_method,
                MATH::CTransformation* in_pTransfo,
                LONG in_nbFacetsToRestrictSearch,
                const LONG* in_pFacetsToRestrictSearch,
                LONG in_nbLocatorsToBeQueried
        );

        CStatus SetupClosestLocationQueries
        (
                siClosestLocationMethod in_method = siClosestSurface,
                MATH::CTransformation* in_pTransfo = NULL,
                LONG in_nbFacetsToRestrictSearch = -1,
                const LONG* in_pFacetsToRestrictSearch = NULL
        )
        {
                return SetupPointLocatorQueries( in_method, in_pTransfo, in_nbFacetsToRestrictSearch, in_pFacetsToRestrictSearch, -1 );
        }

        CStatus EvaluatePositions
        (
                const PointLocatorData& in_ptLocators,
                LONG in_nbPointLocatorsIndices, //-1 if all
                const LONG* in_pPointLocatorsIndices, // 0 if all
                double* out_pPositions
        ) const;

        CStatus EvaluateNormals
        (
                const PointLocatorData& in_ptLocators,
                siNormalComputationMethod in_ComputationMethod,
                LONG in_nbPointLocatorsIndices, //-1 if all
                const LONG* in_pPointLocatorsIndices, // 0 if all
                double* out_pNormals
        ) const;

        CStatus EvaluateClusterProperty
        (
                const PointLocatorData& in_ptLocators,
                LONG in_nbPointLocatorsIndices, //-1 if all
                const LONG* in_pPointLocatorsIndices, // 0 if all
                const Cluster& in_parentCluster,
                const ClusterProperty& in_clusterProperty,
                float* out_pData
        ) const;

        CStatus PutCache
        (
                CValue & in_Cache
        );

        CValue GetCache();

        CStatus GetBoundingBox
        (
           double                & out_centerx,
           double                & out_centery,
           double                & out_centerz,
           double                & out_extentx,
           double                & out_extenty,
           double                & out_extentz,
           const MATH::CTransformation & in_XfoObjectToBBoxSpace
        ) const;


        CStatus GetBoundingSphere
        (
           double                      & out_centerx,
           double                      & out_centery,
           double                      & out_centerz,
           double                      & out_radius,
           siVolumeCenterMethod          in_centerMethod,
           const MATH::CTransformation & in_XfoObjectToBSphereSpace
    );

        CStatus GetBoundingCapsule
        (
            double                        & out_centerx,
                double                        & out_centery,
                double                        & out_centerz,
                double                        & out_length,
                double                        & out_radius,
                siVolumeCenterMethod            in_centerMethod,
                siBoundingCapsuleMethod         in_axisMethod,
                const MATH::CTransformation   & in_XfoObjectToBCapsuleSpace
        ) ;

        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 );

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

};

#endif // __XSIGEOMETRY_H__