fbxmarker.h

Go to the documentation of this file.

/****************************************************************************************
 
   Copyright (C) 2012 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 _FBXSDK_SCENE_GEOMETRY_MARKER_H_
#define _FBXSDK_SCENE_GEOMETRY_MARKER_H_

#include <fbxsdk/fbxsdk_def.h>

#include <fbxsdk/scene/geometry/fbxnodeattribute.h>
#include <fbxsdk/core/math/fbxvector4.h>

#include <fbxsdk/fbxsdk_nsbegin.h>

class FbxManager;

class FBXSDK_DLL FbxMarker : public FbxNodeAttribute
{
    FBXSDK_OBJECT_DECLARE(FbxMarker,FbxNodeAttribute);

public:
    virtual FbxNodeAttribute::EType GetAttributeType() const;

    void Reset();

    enum EType
    {
        eStandard, 
        eOptical, 
        eEffectorFK,
        eEffectorIK
    };

    void SetType(EType pType);

    EType GetType() const;

    enum ELook
    { 
        eCube, 
        eHardCross, 
        eLightCross, 
        eSphere,
        eCapsule,
        eBox,
        eBone,
        eCircle,
        eSquare,
        eStick,
        eNone
    };
    

    double GetDefaultOcclusion() const;

    void SetDefaultOcclusion(double pOcclusion);

    double GetDefaultIKReachTranslation() const;

    void SetDefaultIKReachTranslation(double pIKReachTranslation);

    double GetDefaultIKReachRotation() const;

    void SetDefaultIKReachRotation(double pIKReachRotation);



    FbxColor& GetDefaultColor(FbxColor& pColor) const;

    void SetDefaultColor(FbxColor& 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 FbxBool        sDefaultDrawLink;
    static const FbxDouble      sDefaultSize;
    static const FbxBool        sDefaultShowLabel;
    static const FbxDouble3     sDefaultIKPivot;

    //
    // Properties
    //
    
    FbxPropertyT<ELook> Look;
    
    FbxPropertyT<FbxBool> DrawLink;
    
    FbxPropertyT<FbxDouble> Size;
    
    FbxPropertyT<FbxBool> ShowLabel;
    
    FbxPropertyT<FbxDouble3> IKPivot;

    // Dynamic properties

    FbxProperty* GetOcclusion();

    FbxProperty* GetIKReachTranslation();
    FbxProperty* GetIKReachRotation();

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

    virtual FbxObject& Copy(const FbxObject& pObject);

protected:
    FbxMarker(FbxManager& pManager, char const* pName);

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

    void Reset( bool pResetProperties );

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

    EType mType;

    FbxProperty 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
};

inline EFbxType FbxTypeOf(const FbxMarker::ELook&){ return eFbxEnum; }

#include <fbxsdk/fbxsdk_nsend.h>

#endif /* _FBXSDK_SCENE_GEOMETRY_MARKER_H_ */