kfbxskeleton.h

Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXSKELETON_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXSKELETON_H
00006 
00007 /**************************************************************************************
00008 
00009  Copyright (C) 2001 - 2010 Autodesk, Inc. and/or its licensors.
00010  All Rights Reserved.
00011 
00012  The coded instructions, statements, computer programs, and/or related material 
00013  (collectively the "Data") in these files contain unpublished information 
00014  proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00015  Canada and United States of America federal copyright law and by international 
00016  treaties. 
00017  
00018  The Data may not be disclosed or distributed to third parties, in whole or in
00019  part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00020 
00021  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00022  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00023  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00024  BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00025  NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00026  WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00027  OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
00028  
00029  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
00030  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
00031  OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00032  SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00033  OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00034  HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00035  FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00036  ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00037  WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00038  OR DAMAGE. 
00039 
00040 **************************************************************************************/
00041 #include <fbxfilesdk/fbxfilesdk_def.h>
00042 
00043 #include <fbxfilesdk/components/kbaselib/klib/kerror.h>
00044 
00045 #include <fbxfilesdk/kfbxplugins/kfbxnodeattribute.h>
00046 #include <fbxfilesdk/kfbxplugins/kfbxcolor.h>
00047 
00048 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00049 
00050 class KFbxSdkManager;
00051 
00064 class KFBX_DLL KFbxSkeleton : public KFbxNodeAttribute
00065 {
00066     KFBXOBJECT_DECLARE(KFbxSkeleton,KFbxNodeAttribute);
00067 
00068 public:
00070     virtual EAttributeType GetAttributeType() const;
00071 
00073     void Reset();
00074 
00079 
00085     typedef enum   
00086     {
00087         eROOT,          
00088         eLIMB,          
00089         eLIMB_NODE,     
00090         eEFFECTOR       
00091     } ESkeletonType;    
00092 
00096     void SetSkeletonType(ESkeletonType pSkeletonType);
00097 
00101     ESkeletonType GetSkeletonType() const;
00102 
00108     bool GetSkeletonTypeIsSet() const;
00109 
00113     ESkeletonType GetSkeletonTypeDefaultValue() const;
00114         
00118     double GetLimbLengthDefaultValue() const;
00119     
00123     double GetLimbNodeSizeDefaultValue() const;
00124 
00130     bool SetLimbNodeColor(const KFbxColor& pColor);
00131     
00136     KFbxColor GetLimbNodeColor() const;
00137 
00143     bool GetLimbNodeColorIsSet() const;
00144 
00148     KFbxColor GetLimbNodeColorDefaultValue() const;
00149 
00155     bool IsSkeletonRoot() const;
00156 
00158 
00159 
00163     static const char*          sSize;
00164     static const char*          sLimbLength;
00165 
00170     static const fbxDouble1     sDefaultSize;
00171     static const fbxDouble1     sDefaultLimbLength;
00172 
00173 
00175     //
00176     // Properties
00177     //
00179     
00187     KFbxTypedProperty<fbxDouble1>       Size;
00188 
00196     KFbxTypedProperty<fbxDouble1>           LimbLength;
00197 
00199 //
00200 //  WARNING!
00201 //
00202 //  Anything beyond these lines may not be documented accurately and is 
00203 //  subject to change without notice.
00204 //
00206 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00207 
00208     virtual KFbxObject& Copy(const KFbxObject& pObject);
00209     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00210 
00211 protected:
00212     KFbxSkeleton(KFbxSdkManager& pManager, char const* pName);
00213 
00214     virtual void Construct(const KFbxSkeleton* pFrom);
00215     virtual bool ConstructProperties(bool pForceSet);
00216 
00217     void Reset( bool pResetProperties );
00218 
00219     virtual KString     GetTypeName() const;
00220     virtual KStringList GetTypeFlags() const;
00221 
00222     ESkeletonType mSkeletonType;
00223 
00224     bool mLimbLengthIsSet;
00225     bool mLimbNodeSizeIsSet;
00226     bool mLimbNodeColorIsSet;
00227     bool mSkeletonTypeIsSet;
00228 
00229 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00230 };
00231 
00232 typedef KFbxSkeleton* HKFbxSkeleton;
00233 
00234 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00235 
00236 #endif // FBXFILESDK_KFBXPLUGINS_KFBXSKELETON_H
00237