fbgeometry.h

Go to the documentation of this file.

#ifndef __FBGEOMETRY_H__
#define __FBGEOMETRY_H__
/**************************************************************************
Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
All Rights Reserved.

The coded instructions, statements, computer programs, and/or related 
material (collectively the "Data") in these files contain unpublished 
information proprietary to Autodesk, Inc. and/or its licensors, which is 
protected by Canada and United States of America federal copyright law 
and by international treaties.

The Data may not be disclosed or distributed to third parties, in whole 
or in part, without the prior written consent of Autodesk, Inc. 
("Autodesk").

THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
FREE.

IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

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

#include <kaydaradef.h>
#ifndef FBSDK_DLL 

#define FBSDK_DLL K_DLLIMPORT
#endif

#include <fbsdk/fbcore.h>
#include <fbsdk/fbcomponent.h>

#ifdef FBSDKUseNamespace
namespace FBSDKNamespace {
#endif

    FB_DEFINE_COMPONENT( FBSDK_DLL, Geometry         );
    FB_DEFINE_COMPONENT( FBSDK_DLL, Mesh             );

    enum FBGeometryPrimitiveType
    {
        kFBGeometry_POINTS              = 0x0000, //GL_POINTS,
        kFBGeometry_LINES               = 0x0001, //GL_LINES,
        kFBGeometry_LINE_LOOP           = 0x0002, //GL_LINE_LOOP,
        kFBGeometry_LINE_STRIP          = 0x0003, //GL_LINE_STRIP,
        kFBGeometry_TRIANGLES           = 0x0004, //GL_TRIANGLES,
        kFBGeometry_TRIANGLE_STRIP      = 0x0005, //GL_TRIANGLE_STRIP,
        kFBGeometry_TRIANGLE_FAN        = 0x0006, //GL_TRIANGLE_FAN,
        kFBGeometry_QUADS               = 0x0007, //GL_QUADS,
        kFBGeometry_QUADS_STRIP         = 0x0008, //GL_QUAD_STRIP,
        kFBGeometry_POLYGON             = 0x0009, //GL_POLYGON,
    };

    enum FBGeometryArrayID 
    { 
        kFBGeometryArrayID_Point          =  1 << 0,    
        kFBGeometryArrayID_Normal         =  1 << 1,    
        kFBGeometryArrayID_Tangent        =  1 << 2,    
        kFBGeometryArrayID_Binormal       =  1 << 3,    
        kFBGeometryArrayID_Color          =  1 << 4     
    };

    K_DEPRECATED_2014 const int kFBGeometryArrayID_NormalByPoint = kFBGeometryArrayID_Normal; 
    
    K_DEPRECATED_2014 const int kFBGeometryArrayID_VertexColor   = kFBGeometryArrayID_Color;


    enum FBGeometryArrayElementType {
        kFBGeometryArrayElementType_Unknown,
        kFBGeometryArrayElementType_Integer, 
        kFBGeometryArrayElementType_Float,
        kFBGeometryArrayElementType_Float2,
        kFBGeometryArrayElementType_Float3,     
        kFBGeometryArrayElementType_Float4,      
        kFBGeometryArrayElementType_FloatMatrix4x4,
        kFBGeometryArrayElementType_IntegerArrayPointer
    };

    // FBGeometry
    __FB_FORWARD( FBGeometry );


    enum FBGeometryMappingMode
    {
        kFBGeometryMapping_NONE,
        kFBGeometryMapping_BY_CONTROL_POINT,
        kFBGeometryMapping_BY_POLYGON_VERTEX,
        kFBGeometryMapping_BY_POLYGON,
        kFBGeometryMapping_BY_EDGE,
        kFBGeometryMapping_ALL_SAME
    } ;

    enum FBGeometryReferenceMode
    {
        kFBGeometryReference_DIRECT,
        kFBGeometryReference_INDEX,
        kFBGeometryReference_INDEX_TO_DIRECT    
    };

    FB_DEFINE_ENUM( FBSDK_DLL, GeometryMappingMode ); 
    FB_DEFINE_ENUM( FBSDK_DLL, GeometryReferenceMode ); 

    enum kFBGeometryUpdateFlags
    {
        kFBGeometryUpdateNone                = 0,        
        kFBGeometryUpdateAll                 = 1 << 0,   
        kFBGeometryUpdatePositionAndNormal   = 1 << 1,   
        kFBGeometryUpdateSkinWeight          = 1 << 2,   
        kFBGeometryUpdateInverseNormal       = 1 << 3,   
        kFBGeometryUpdateMappingMode         = 1 << 4,   
    };

    class FBSDK_DLL FBGeometry : public FBComponent {
        __FBClassDeclare( FBGeometry,FBComponent );

    protected:
        FBGeometry(const char* pName, HIObject pObject=NULL);

    public:

        bool        GeometryBegin();

        bool        GeometryEnd();

        bool        IsEditingEnabled() const;

        void        VertexInit    (int pSize, bool pResize, bool pInitUV = true, bool pInitVertexColor = false);

        bool        VertexClear    ();

        int         VertexAdd    (FBVertex pVertex);

        int         VertexAdd    (FBVertex pVertex, FBNormal pNormal);

        int         VertexAdd    (FBVertex pVertex, FBNormal pNormal, FBUV pUV);

        int         VertexAdd    (FBVertex pVertex, FBNormal pNormal, FBUV pUV, FBColorF pVertexColor);

        int         VertexAdd    (double px, double py, double pz);
        int         VertexAdd    (double px, double py, double pz, double nx, double ny, double nz);
        int         VertexAdd    (double px, double py, double pz, double nx, double ny, double nz, double UVu, double UVv);
        int         VertexAdd    (double px, double py, double pz, double nx, double ny, double nz, double UVu, double UVv, double pRed, double pGreen, double pBlue, double pAlpha);

        bool        VertexSet    (FBVertex pVertex,int pIndex=-1);

        bool        VertexSet    (double px, double py, double pz,int pIndex=-1);

        bool        VertexNormalSet(FBNormal pVertex,int pIndex=-1);

        bool        VertexNormalSet(double px, double py, double pz,int pIndex=-1);


        bool        VertexUVSet(FBUV pUV, int pIndex=-1);

        bool        VertexUVSet(float pU, float pV, int pIndex=-1);

        bool        VertexColorSet(FBColorF pColor, int pIndex=-1);

        bool        VertexColorSet(float pRed, float pGreen, float pBlue, float pAlpha, int pIndex=-1);



        int         VertexCount    () const;

        FBVertex    VertexGet    (int pIndex) const;

        FBVertex*    GetVertexes() const;

        FBNormal    VertexNormalGet(int pIndex=-1) const;

        FBUV        VertexUVGet(int pIndex=-1) const;

        FBColorF    VertexColorGet(int pIndex=-1) const;




        bool        VertexArrayInit (int pVertexcount, bool pUniqueMaterial, unsigned int pFBGeometryArrayIDs = 0);

        bool        VertexArrayClear();

        FBVertex*       GetPositionsArray(int& pOutArrayCount) const;

        FBPropertyGeometryMappingMode       NormalMappingMode;          
        FBPropertyGeometryReferenceMode     NormalReferenceMode;        

        int*            GetNormalsIndexArray(int& pOutArrayCount) const;

        FBNormal*       GetNormalsDirectArray(int& pOutArrayCount) const;

        FBPropertyGeometryMappingMode       TangentMappingMode;          
        FBPropertyGeometryReferenceMode     TangentReferenceMode;        

        int*            GetTangentsIndexArray(int& pOutArrayCount) const;

        FBNormal*       GetTangentsDirectArray(int& pOutArrayCount) const;

        FBPropertyGeometryMappingMode       BinormalMappingMode;          
        FBPropertyGeometryReferenceMode     BinormalReferenceMode;        

        int*            GetBinormalsIndexArray(int& pOutArrayCount) const;

        FBNormal*       GetBinormalsDirectArray(int& pOutArrayCount) const;

        FBPropertyGeometryMappingMode    VertexColorMappingMode;        
        FBPropertyGeometryReferenceMode  VertexColorReferenceMode;      

        int*            GetVertexColorsIndexArray(int& pOutArrayCount) const;

        FBColorF*       GetVertexColorsDirectArray(int& pOutArrayCount) const;

        FBStringList    GetUVSets() const;

        FBGeometryMappingMode    GetUVSetMappingMode(const char* pUVSetName = NULL) const;

        FBGeometryReferenceMode GetUVSetReferenceMode(const char* pUVSetName = NULL) const;

        int*        GetUVSetIndexArray(int& pOutArrayCount, const char* pUVSetName = NULL) const;

        FBUV*       GetUVSetDirectArray(int& pOutArrayCount, const char* pUVSetName = NULL) const;

        FBPropertyGeometryMappingMode    MaterialMappingMode;    

        int*        GetMaterialIndexArray(int& pOutArrayCount) const;



        bool VertexGetSelected(int pIndex);
        
        bool VertexSetSelected(int pIndex,bool pState);

        bool VertexGetVisible(int pIndex);

        bool VertexSetVisible(int pIndex,bool pState);

        bool VertexGetTransformable(int pIndex);


        int ShapeGetCount() const;

        const char* ShapeGetName(int pShapeIdx) const;

        int ShapeAdd(const char* pName);

        void ShapeClearAll();

        void ShapeInit(int pShapeIdx, int pDiffSize, bool pWithNormal = false);

        int ShapeGetDiffPointCount(int pShapeIdx) const;

        bool ShapeSetDiffPoint(int pShapeIdx, int pDiffIndex, int pOriIndex, const FBVertex& pPosDiff);

        bool ShapeSetDiffPoint(int pShapeIdx, int pDiffIndex, int pOriIndex, const FBVertex& pPosDiff, const FBNormal& pNormalDiff);

        bool ShapeGetDiffPoint(int pShapeIdx, int pDiffIndex, int& pOriIndex, FBVertex& pPosDiff) const;

        bool ShapeGetDiffPoint(int pShapeIdx, int pDiffIndex, int& pOriIndex, FBVertex& pPosDiff, FBNormal& pNormalDiff) const;



        void ModifyNotify( kFBGeometryUpdateFlags pFlags=kFBGeometryUpdateAll, int pFirstIndex=-1, int pLastIndex=-1 );

    };

    // FBMesh
    __FB_FORWARD( FBMesh );

    class FBSDK_DLL FBMesh : public FBGeometry {
        __FBClassDeclare( FBMesh,FBGeometry );

    public:
        FBMesh(const char* pName, HIObject pObject=NULL);

        bool TriangleListAdd(int pIndexArraySize, int* pIndexArray, int pMaterialId=0);

        bool TriangleStripAdd(int pIndexArraySize, int* pIndexArray, int pMaterialId=0);

        bool PolygonListAdd(int pPolygonSize, int pIndexArraySize, int* pIndexArray, int pMaterialId=0);

        int PolygonBegin(int pMaterialId=0);

        bool PolygonVertexAdd(int pVertex);

        int PolygonEnd();

        int PolygonVertexCount(int pPolygonIndex) const;

        int PolygonVertexIndex(int pPolygonIndex, int pVertexPolygonIndex) const;

        int PolygonCount() const;

        const int* PolygonVertexArrayGet(int& pArraySize) const;

        bool IsTriangleMesh() const;

        int PolygonMaterialIdGet(int pIndex=-1) const;

        void ComputeVertexNormals(bool pCW = false);

        void InverseNormal();
    };

    // FBSurface
    __FB_FORWARD( FBSurface );

    enum FBSurfaceMode
    {
        kFBSurfaceModeRaw,               
        kFBSurfaceModeLowNoNormals,      
        kFBSurfaceModeLow,               
        kFBSurfaceModeHighNoNormals,     
        kFBSurfaceModeHigh               
    };
    FB_DEFINE_ENUM( FBSDK_DLL, SurfaceMode );

    enum FBSurfaceType
    {
        kFBSurfaceTypeBezier,            
        kFBSurfaceTypeBezierQuadric,     
        kFBSurfaceTypeCardinal,          
        kFBSurfaceTypeBspline,           
        kFBSurfaceTypeLinear,            
    };
    FB_DEFINE_ENUM( FBSDK_DLL, SurfaceType );


    class FBSDK_DLL FBSurface : public FBGeometry
    {
        __FBClassDeclare( FBSurface, FBGeometry );

    public:
        FBSurface(const char* pName, HIObject pObject=NULL);

        virtual void    SurfaceBegin();
        virtual void    SurfaceEnd();
        virtual void    SurfaceEditBegin();
        virtual void    SurfaceEditEnd();
        virtual bool    GetSurfaceCapped( int pUorV, int pDirection );
        virtual int     GetVertexCount( int pUorVorGlobal = -1 );
        virtual void    ControlPointsBegin() = 0;
        virtual void    SetControlPoint( int pIndex, double pX, double pY, double pZ, double pW );
        virtual void    GetControlPoint( int pIndex, double &pX, double &pY, double &pZ, double &pW );
        virtual void    ControlPointsEnd();

        bool VertexGetSelected(int pU,int pV);
        bool VertexSetSelected(int pU,int pV,bool pState);

        bool VertexGetVisible(int pU,int pV);

        bool VertexSetVisible(int pU,int pV,bool pState);

        bool VertexGetTransformable(int pU,int pV);


        FBPropertyInt            USize;        
        FBPropertyInt            VSize;        
        FBPropertyInt            UStep;        
        FBPropertyInt            VStep;        
        FBPropertyBool           UClosed;      
        FBPropertyBool           VClosed;      
        FBPropertySurfaceMode    SurfaceMode;  

    private:
        void FBSurfaceInitProperties();
    };

    enum FBNurbType
    {
        kFBNurbTypePeriodic,    
        kFBNurbTypeClosed,      
        kFBNurbTypeOpen,        
    };
    FB_DEFINE_ENUM( FBSDK_DLL, NurbType );


    // FBNurbs
    __FB_FORWARD( FBNurbs );

    class FBSDK_DLL FBNurbs : public FBSurface
    {
        __FBClassDeclare( FBNurbs, FBSurface );

    public:
        FBNurbs(const char* pName, HIObject pObject=NULL);

        virtual void    SurfaceBegin();

        virtual void    SurfaceEnd();

        virtual void    SurfaceEditBegin();
        virtual void    SurfaceEditEnd();
        virtual void    ControlPointsBegin();
        virtual void    ControlPointsEnd();
        virtual void    SetControlWeight( int pIndex, double pWeight );
        virtual double    GetControlWeight( int pIndex );
        virtual void    SetControlMultiplicity( int pUorV, int pIndex, int    pMultiplicity    );
        virtual int        GetControlMultiplicity( int pUorV, int pIndex );
        virtual void    SetControlKnotValue( int pUorV, int pIndex, double    pKnotValue        );
        virtual double    GetControlKnotValue( int pUorV, int pIndex );
        virtual int        GetKnotCount( int pUorV );

        FBPropertyInt            UOrder;            
        FBPropertyInt            VOrder;            
        FBPropertyNurbType       UNurbType;        
        FBPropertyNurbType       VNurbType;        

    private:
        void FBNurbsInitProperties();
    };

    // FBPatch
    __FB_FORWARD( FBPatch );

    class FBSDK_DLL FBPatch : public FBSurface
    {
        __FBClassDeclare( FBPatch, FBSurface );

    public:
        FBPatch(const char* pName, HIObject pObject=NULL);

        virtual void SurfaceBegin();

        virtual void SurfaceEnd();

        virtual void SurfaceEditBegin();

        virtual void SurfaceEditEnd();

        virtual void ControlPointsBegin();
        virtual void ControlPointsEnd();


        FBPropertySurfaceType    USurfaceType;        
        FBPropertySurfaceType    VSurfaceType;        

    private:
        void FBPatchInitProperties();

    };

#ifdef FBSDKUseNamespace
}
#endif
#endif