kfbxmarker.h

Go to the documentation of this file.

#ifndef FBXFILESDK_KFBXPLUGINS_KFBXMARKER_H
#define FBXFILESDK_KFBXPLUGINS_KFBXMARKER_H

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

 Copyright (C) 2001 - 2010 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 <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
    } 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*          sSize;
    static const char*          sShowLabel;
    static const char*          sIKPivot;

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

    //
    // Properties
    //
    
    KFbxTypedProperty<ELook> Look;
    
    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);
    virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;

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

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

    void Reset( bool pResetProperties );

    virtual KString     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