fbxsdk/scene/constraint/fbxconstraint.h Source File

fbxconstraint.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_CONSTRAINT_H_
14 #define _FBXSDK_SCENE_CONSTRAINT_H_
15 
16 #include <fbxsdk/fbxsdk_def.h>
17 
18 #include <fbxsdk/core/fbxobject.h>
19 #include <fbxsdk/fbxsdk_nsbegin.h>
20 
28 {
30 
31 public:
41 
48 
57 
60  enum EType
61  {
68  eAim,
70  eCustom
71  };
72 
76  virtual EType GetConstraintType() const { return eUnknown; }
77 
81  virtual FbxObject* GetConstrainedObject() const { return NULL; }
82 
86  virtual int GetConstraintSourceCount() const { return 0; }
87 
92  virtual FbxObject* GetConstraintSource(int /*pIndex*/) const { return NULL; }
93 
98  double GetSourceWeight(const FbxObject* pObject) const;
99 
100 /*****************************************************************************************************************************
101 ** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
102 *****************************************************************************************************************************/
103 #ifndef DOXYGEN_SHOULD_SKIP_THIS
104 protected:
105  virtual void Construct(const FbxObject* pFrom);
106  virtual void ConstructProperties(bool pForceSet);
107 
108 #endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
109 };
110 
111 /*****************************************************************************************************************************
112 ** WARNING! Anything beyond these lines is for internal use, may not be documented and is subject to change without notice! **
113 *****************************************************************************************************************************/
114 #ifndef DOXYGEN_SHOULD_SKIP_THIS
115 
116 const FbxString GetWeightPropertyName(const FbxObject * pObject);
117 void CreateWeightPropertyForSourceObject(FbxObject * pConstraint, const FbxObject * pSourceObject, double pWeightValue);
118 
119 #endif /* !DOXYGEN_SHOULD_SKIP_THIS *****************************************************************************************/
120 
121 #include <fbxsdk/fbxsdk_nsend.h>
122 
123 #endif /* _FBXSDK_SCENE_CONSTRAINT_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.
virtual FbxObject * GetConstrainedObject() const
Retrieve the constrained object.
Definition: fbxconstraint.h:81
#define NULL
Definition: fbxarch.h:210
Utility class to manipulate strings.
Definition: fbxstring.h:66
Scale constraint.
Definition: fbxconstraint.h:66
virtual EType GetConstraintType() const
Access the type of the constraint.
Definition: fbxconstraint.h:76
virtual FbxObject * GetConstraintSource(int) const
Retrieve a constraint source with the specified index.
Definition: fbxconstraint.h:92
Base class for weighted animation constraints.
Definition: fbxconstraint.h:27
FbxPropertyT< FbxBool > Lock
This property handles the lock state of the constraint.
Definition: fbxconstraint.h:55
The base class of most FBX objects.
Definition: fbxobject.h:157
Position constraint (referred to as a point constraint in Maya).
Definition: fbxconstraint.h:64
FbxPropertyT< FbxDouble > Weight
This property represents the degree of influence of a constraint from 0.0 (no influence) to 100...
Definition: fbxconstraint.h:40
virtual void Construct(const FbxObject *pFrom)
Optional constructor override, automatically called by default constructor.
FbxPropertyT< FbxBool > Active
This property controls whether the constraint is applied or not.
Definition: fbxconstraint.h:47
EType
Constraint attribute types.
Definition: fbxconstraint.h:60
Invalid constraint.
Definition: fbxconstraint.h:63
#define FBXSDK_DLL
Definition: fbxarch.h:173
Single chain IK constraint.
Definition: fbxconstraint.h:68
virtual int GetConstraintSourceCount() const
Retrieve the count of constraint source.
Definition: fbxconstraint.h:86
virtual void ConstructProperties(bool pForceSet)
Optional property constructor override, automatically called by default constructor.
Rotation constraint (referred to as an orient constraint in Maya).
Definition: fbxconstraint.h:65