kfbxskeleton.h

Go to the documentation of this file.

#ifndef _FBXSDK_SKELETON_H_
#define _FBXSDK_SKELETON_H_

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

 Copyright © 2001 - 2007 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 KFBX_DLL 
    #define KFBX_DLL K_DLLIMPORT
#endif

#include <kaydara.h>

#include <klib/kerror.h>

#include <kfbxplugins/kfbxnodeattribute.h>
#include <kfbxplugins/kfbxcolor.h>

#include <fbxfilesdk_nsbegin.h>

class KFbxSdkManager;
class KFbxSkeleton_internal;

class KFBX_DLL KFbxSkeleton : public KFbxNodeAttribute
{
    KFBXOBJECT_DECLARE(KFbxSkeleton);

public:
    virtual EAttributeType GetAttributeType() const;

    void Reset();


    typedef enum   
    {
        eROOT, 
        eLIMB, 
        eLIMB_NODE, 
        eEFFECTOR
    } ESkeletonType;    

    void SetSkeletonType(ESkeletonType pSkeletonType);

    ESkeletonType GetSkeletonType() const;

    bool GetSkeletonTypeIsSet() const;

    ESkeletonType GetSkeletonTypeDefaultValue() const;
        
    bool SetLimbLength(double pLength);
    
    double GetLimbLength() const;

    bool GetLimbLengthIsSet() const;

    double GetLimbLengthDefaultValue() const;
    
    bool SetLimbNodeSize(double pSize);
    
    double GetLimbNodeSize() const;

    bool GetLimbNodeSizeIsSet() const;

    double GetLimbNodeSizeDefaultValue() const;

    bool SetLimbNodeColor(const KFbxColor& pColor);
    
    KFbxColor GetLimbNodeColor() const;

    bool GetLimbNodeColorIsSet() const;

    KFbxColor GetLimbNodeColorDefaultValue() const;


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

#ifndef DOXYGEN_SHOULD_SKIP_THIS

public:

    virtual KObject*  GetFbxObject_internal();
    virtual KObject const*  GetFbxObject_internal() const;

    // Clone
    virtual KFbxObject* Clone(KFbxObject::ECloneType pCloneType) const;

protected:
    static char const* GetNamePrefix() { return 0; }

    KFbxSkeleton(KFbxSdkManager& pManager, char const* pName);
    ~KFbxSkeleton();

    virtual void Destruct(bool pRecursive, bool pDependents);

    KFbxSkeleton& operator=(KFbxSkeleton const& pSkeleton);

    virtual KString     GetTypeName() const;
    virtual KStringList GetTypeFlags() const;

    // Property Handler
    KFbxSkeleton_internal* mPH;

    ESkeletonType mSkeletonType;

    bool mLimbLengthIsSet;
    bool mLimbNodeSizeIsSet;
    bool mLimbNodeColorIsSet;
    bool mSkeletonTypeIsSet;

    friend class KFbxReaderFbx;
    friend class KFbxWriterFbx;

#endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

};

typedef KFbxSkeleton* HKFbxSkeleton;

#include <fbxfilesdk_nsend.h>

#endif // #ifndef _FBXSDK_SKELETON_H_