kfbxmarker.h

Go to the documentation of this file.

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

   Copyright (C) 2010 Autodesk, Inc.
   All rights reserved.

   Use of this software is subject to the terms of the Autodesk license agreement
   provided at the time of installation or download, or which otherwise accompanies
   this software in either electronic or hard copy form.

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

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXMARKER_H
#define FBXFILESDK_KFBXPLUGINS_KFBXMARKER_H


#include <fbxfilesdk/fbxfilesdk_def.h>

#include <fbxfilesdk/kfbxplugins/kfbxnodeattribute.h>
#include <fbxfilesdk/kfbxplugins/kfbxcolor.h>
#include <fbxfilesdk/kfbxmath/kfbxvector4.h>

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

class KFbxSdkManager;

class KFBX_DLL KFbxMarker : public KFbxNodeAttribute
{
    KFBXOBJECT_DECLARE(KFbxMarker,KFbxNodeAttribute);

public:
    virtual EAttributeType GetAttributeType() const;

    void Reset();

    typedef enum { 
        eSTANDARD, 
        eOPTICAL, 
        eFK_EFFECTOR,
        eIK_EFFECTOR
    } EType;

    void SetType(EType pType);

    EType GetType() const;

    typedef enum { 
        eCUBE, 
        eHARD_CROSS, 
        eLIGHT_CROSS, 
        eSPHERE,
        eCAPSULE,
        eBOX,
        eBONE,
        eCIRCLE,
        eSQUARE,
        eSTICK,
        eNONE
    } ELook;
    

    double GetDefaultOcclusion() const;

    void SetDefaultOcclusion(double pOcclusion);

    double GetDefaultIKReachTranslation() const;

    void SetDefaultIKReachTranslation(double pIKReachTranslation);

    double GetDefaultIKReachRotation() const;

    void SetDefaultIKReachRotation(double pIKReachRotation);



    KFbxColor& GetDefaultColor(KFbxColor& pColor) const;

    void SetDefaultColor(KFbxColor& pColor);


    static const char*          sLook;
    static const char*            sDrawLink;
    static const char*          sSize;
    static const char*          sShowLabel;
    static const char*          sIKPivot;

    static const ELook          sDefaultLook;
    static const fbxBool1        sDefaultDrawLink;
    static const fbxDouble1     sDefaultSize;
    static const fbxBool1       sDefaultShowLabel;
    static const fbxDouble3     sDefaultIKPivot;

    //
    // Properties
    //
    
    KFbxTypedProperty<ELook> Look;
    
    KFbxTypedProperty<fbxBool1> DrawLink;
    
    KFbxTypedProperty<fbxDouble1> Size;
    
    KFbxTypedProperty<fbxBool1> ShowLabel;
    
    KFbxTypedProperty<fbxDouble3> IKPivot;

    // Dynamic properties

    KFbxProperty* GetOcclusion();

    KFbxProperty* GetIKReachTranslation();
    KFbxProperty* GetIKReachRotation();

//
//  WARNING!
//
//  Anything beyond these lines may not be documented accurately and is 
//  subject to change without notice.
//
#ifndef DOXYGEN_SHOULD_SKIP_THIS

    virtual KFbxObject& Copy(const KFbxObject& pObject);

protected:
    KFbxMarker(KFbxSdkManager& pManager, char const* pName);

    virtual void Construct(const KFbxMarker* pFrom);
    virtual bool ConstructProperties(bool pForceSet);

    void Reset( bool pResetProperties );

    virtual const char* GetTypeName() const;
    virtual KStringList GetTypeFlags() const;

    EType mType;

    KFbxProperty dynProp; // temporary placeholder for either
    // the Occlusion, IKReachTranslation or IKReachRotation 
    // properties. Its address is returned in the GetOcclusion(),
    // GetIKReachTranslation() and GetIKReachRotation() if the property
    // is valid
#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
};

typedef KFbxMarker* HKFbxMarker;

inline EFbxType FbxTypeOf( KFbxMarker::ELook const &pItem )         { return eENUM; }

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_KFBXPLUGINS_KFBXMARKER_H