fbxsdk/scene/geometry/fbxskeleton.h Source File

fbxskeleton.h
Go to the documentation of this file.
1 /****************************************************************************************
2 
3  Copyright (C) 2015 Autodesk, Inc.
4  All rights reserved.
5 
6  Use of this software is subject to the terms of the Autodesk license agreement
7  provided at the time of installation or download, or which otherwise accompanies
8  this software in either electronic or hard copy form.
9 
10 ****************************************************************************************/
11 
13 #ifndef _FBXSDK_SCENE_GEOMETRY_SKELETON_H_
14 #define _FBXSDK_SCENE_GEOMETRY_SKELETON_H_
15 
16 #include <fbxsdk/fbxsdk_def.h>
17 
19 
20 #include <fbxsdk/fbxsdk_nsbegin.h>
21 
35 {
37 
38 public:
41 
43  void Reset();
44 
49 
55  enum EType
56  {
60  eEffector
61  };
62 
66  void SetSkeletonType(EType pSkeletonType);
67 
71  EType GetSkeletonType() const;
72 
78  bool GetSkeletonTypeIsSet() const;
79 
83  EType GetSkeletonTypeDefaultValue() const;
84 
88  double GetLimbLengthDefaultValue() const;
89 
93  double GetLimbNodeSizeDefaultValue() const;
94 
100  bool SetLimbNodeColor(const FbxColor& pColor);
101 
106  FbxColor GetLimbNodeColor() const;
107 
113  bool GetLimbNodeColorIsSet() const;
114 
118  FbxColor GetLimbNodeColorDefaultValue() const;
119 
125  bool IsSkeletonRoot() const;
126 
128 
129 
133  static const char* sSize;
134  static const char* sLimbLength;
135 
140  static const FbxDouble sDefaultSize;
142 
143 
145  //
146  // Properties
147  //
149 
158 
173 
174 /*****************************************************************************************************************************
175 ** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
176 *****************************************************************************************************************************/
177 #ifndef DOXYGEN_SHOULD_SKIP_THIS
178  virtual FbxObject& Copy(const FbxObject& pObject);
179 
180 protected:
181  virtual void Construct(const FbxObject* pFrom);
182  virtual void ConstructProperties(bool pForceSet);
183 
184  void Reset( bool pResetProperties );
185 
186  virtual const char* GetTypeName() const;
187  virtual FbxStringList GetTypeFlags() const;
188 
189  EType mSkeletonType;
190 
191  bool mLimbLengthIsSet;
192  bool mLimbNodeSizeIsSet;
193  bool mLimbNodeColorIsSet;
194  bool mSkeletonTypeIsSet;
195 #endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
196 };
197 
198 #include <fbxsdk/fbxsdk_nsend.h>
199 
200 #endif /* _FBXSDK_SCENE_GEOMETRY_SKELETON_H_ */
#define FBXSDK_OBJECT_DECLARE(Class, Parent)
Macro used to declare a new class derived from FbxObject.
Definition: fbxobject.h:61
FBX SDK environment definition.
Chain element.
Definition: fbxskeleton.h:58
static const FbxDouble sDefaultSize
Definition: fbxskeleton.h:140
virtual FbxObject & Copy(const FbxObject &pObject)
Copy an object content into this object.
Array that stores pairs of FbxString and a pointer.
Chain element.
Definition: fbxskeleton.h:59
Class to represent colors in RGBA format using doubles.
EType
Node attribute types.
static const char * sSize
Definition: fbxskeleton.h:133
static const char * sLimbLength
Definition: fbxskeleton.h:134
double FbxDouble
Definition: fbxtypes.h:42
FbxPropertyT< FbxDouble > LimbLength
This property handles the skeleton limb length.
Definition: fbxskeleton.h:172
The base class of most FBX objects.
Definition: fbxobject.h:157
First element of a chain.
Definition: fbxskeleton.h:57
virtual void Construct(const FbxObject *pFrom)
Optional constructor override, automatically called by default constructor.
static const FbxDouble sDefaultLimbLength
Definition: fbxskeleton.h:141
virtual FbxNodeAttribute::EType GetAttributeType() const
Return the type of node attribute.
FbxPropertyT< FbxDouble > Size
This property handles the limb node size.
Definition: fbxskeleton.h:157
#define FBXSDK_DLL
Definition: fbxarch.h:173
This class specializes a node attribute to represent the elements forming "bone" chains.
Definition: fbxskeleton.h:34
This class is the base class to all types of node attributes.
virtual void ConstructProperties(bool pForceSet)
Optional property constructor override, automatically called by default constructor.