fbmodelpath3d.h

Go to the documentation of this file.

#ifndef __FBMODEL_PATH3D_H__
#define __FBMODEL_PATH3D_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>
#include <fbsdk/fbmodel.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

// FBModelPath3D
__FB_FORWARD( FBModelPath3D );

class FBSDK_DLL FBModelPath3D : public FBModel
{
    __FBClassDeclare(FBModelPath3D, FBModel);

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

    enum EKeyPropertyBehavior
    {
        eLegacyVector4, 
        eVector         
    };
    typedef FBPropertyBaseEnum<EKeyPropertyBehavior> PropertyKeyPropertyBehavior;

    enum ELengthUnitType 
    {
        eArchitectural = 0,
        eMI,
        eCM,
        eM,
        eKM
    };
    typedef FBPropertyBaseEnum<ELengthUnitType> PropertyUnitType;

    enum EPathEndCapStyle
    {
        eNone, 
        eArrow
    };

    typedef FBPropertyBaseEnum<EPathEndCapStyle> PropertyPathEndCapStyle;  

    PropertyKeyPropertyBehavior KeyPropertyBehavior; 
    FBPropertyBool   AutoControlNode;           
    FBPropertyDouble PathLength;                
    FBPropertyString PathLengthInString;        
    PropertyUnitType PathLengthUnit;            
    FBPropertyBool   PathLengthShow;            
    FBPropertyDouble TextScale;                 
    FBPropertyColorAndAlpha TextBackground;     
    PropertyPathEndCapStyle PathEndCapStyle;    
    FBPropertyDouble PathEndCapScale;           
    FBPropertyAnimatableColor Color;            

    //--- Visual ------------------------------------------------------------------------------------------------------------------------

    void        ShowCurveControls(bool pShow);

    void        ShowCurvePoints(bool pShow);


    //--- Key Manipulation --------------------------------------------------------------------------------------------------------------
    int         PathKeyGetCount();

    FBVector4d  PathKeyGet(int pKeyIndex);

    void        PathKeySet(int pKeyIndex, FBVector4d pTLocal, bool pUpdate=true);

    void        PathKeySetLeftRightTangent(int pKeyIndex, FBVector4d pKeyTLocal, FBVector4d pLeftTangentTLocal, FBVector4d pRightTangentTLocal, bool pUpdate=true); 

    void        PathKeyRemove(int pKeyIndex);

    void        PathKeyClear();

    //--- Tangent ----------------------------------------------------------------------------------------------------------------------

    void        PathKeySetLeftTangent(int pKeyIndex, FBVector4d pTLocal, bool pUpdate=true);

    void        PathKeySetRightTangent(int pKeyIndex, FBVector4d pTLocal, bool pUpdate=true);

    FBVector4d  PathKeyGetLeftTangent(int pKeyIndex);

    FBVector4d  PathKeyGetRightTangent(int pKeyIndex);

    void        PathKeySetXDerivative(int pKeyIndex, double pDerivative, bool pUpdate);

    void        PathKeySetYDerivative(int pKeyIndex, double pDerivative, bool pUpdate);

    void        PathKeySetZDerivative(int pKeyIndex, double pDerivative, bool pUpdate);

    void        PathKeySetXYZDerivative(int pKeyIndex, FBVector4d pDerivative, bool pUpdate);

    FBVector4d  PathKeyGetXYZDerivative(int pKeyIndex);

    double      PathKeyGetLeftTangentLength(int pKeyIndex);

    double      PathKeyGetRightTangentLength(int pKeyIndex);

    //--- Path remove keys (editing) ----------------------------------------------------------------------------------------------------

    int         GetSelectedPathKeyCount();

    void        PathKeyRemoveSelected();

    //--- Keys Helpers ------------------------------------------------------------------------------------------------------------------

    int        InsertNewStartKey();

    int        InsertNewEndKey();

    int        PathKeyStartAdd(FBVector4d pTLocal);

    int        PathKeyEndAdd(FBVector4d pTLocal);

    int        PathKeyInsertAfter(int pKeyIndex, FBVector4d pTLocal);

    //--- Animated Keys - Properties and Control Nodes ----------------------------------------------------------------------------------

    FBProperty* PathKeyGetProperty(int pKeyIndex);

    FBModel*   PathKeyGetControlNode(int pKeyIndex);

    bool       PathKeySetControlNode(int pKeyIndex, FBModel* pControlNode);

    //--- Curve -------------------------------------------------------------------------------------------------------------------------
    K_DEPRECATED_2017 int Total_PathKeyAdd(double pTotalPercent, FBVector4d pTLocal, FBEvaluateInfo* pEvaluateInfo=NULL);

    int        Total_IsPathKey(double pTotalPercent, FBEvaluateInfo* pEvaluateInfo=NULL);

    FBVector4d Total_GlobalPathEvaluate(double pTotalPercent, FBEvaluateInfo* pEvaluateInfo=NULL);

    FBVector4d Total_LocalPathEvaluate(double pTotalPercent, FBEvaluateInfo* pEvaluateInfo=NULL);

    FBVector4d Total_GlobalPathEvaluateDerivative(double pTotalPercent, FBEvaluateInfo* pEvaluateInfo=NULL);

    FBVector4d Total_LocalPathEvaluateDerivative(double pTotalPercent, FBEvaluateInfo* pEvaluateInfo=NULL);

    K_DEPRECATED_2017 int Segment_PathKeyAdd(double pSegmentPercent, FBVector4d pTLocal, FBEvaluateInfo* pEvaluateInfo=NULL);

    int        Segment_IsPathKey(double pSegmentPercent, FBEvaluateInfo* pEvaluateInfo=NULL);

    FBVector4d Segment_GlobalPathEvaluate(double pSegmentPercent, FBEvaluateInfo* pEvaluateInfo=NULL);

    FBVector4d Segment_LocalPathEvaluate(double pSegmentPercent, FBEvaluateInfo* pEvaluateInfo=NULL);

    FBVector4d Segment_GlobalPathEvaluateDerivative(double pSegmentPercent, FBEvaluateInfo* pEvaluateInfo=NULL);

    FBVector4d Segment_LocalPathEvaluateDerivative(double pSegmentPercent, FBEvaluateInfo* pEvaluateInfo=NULL);

    //--- Key Type Converter ------------------------------------------------------------------------------------------------------------

    double     ConvertTotalPercentToSegmentPercent(double pPercent, FBEvaluateInfo* pEvaluateInfo=NULL);

    double     ConvertSegmentPercentToTotalPercent(double pPercent, FBEvaluateInfo* pEvaluateInfo=NULL);

    double     ConvertToSegmentPercentFactor();

    double     ConvertToTotalPercentFactor();
    
    void      UpdateGeometry();
};

#ifdef FBSDKUseNamespace
}
#endif

#endif