Open Reality Reference Guide
fbcharacterextension.h
Go to the documentation of this file.
1 #ifndef __FBCHARACTEREXTENSION_H__
2 #define __FBCHARACTEREXTENSION_H__
3 /**************************************************************************
4  Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
5  All Rights Reserved.
6 
7  The coded instructions, statements, computer programs, and/or related
8  material (collectively the "Data") in these files contain unpublished
9  information proprietary to Autodesk, Inc. and/or its licensors, which is
10  protected by Canada and United States of America federal copyright law
11  and by international treaties.
12 
13  The Data may not be disclosed or distributed to third parties, in whole
14  or in part, without the prior written consent of Autodesk, Inc.
15  ("Autodesk").
16 
17  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
18  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
19  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR
20  ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES
21  OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
22  PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT
23  WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR
24  FREE.
25 
26  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
27  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR
28  EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE
29  DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS
30  OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR
31  DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF
32  LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT
33  LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE
34  DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS
35  BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
36 
37 **************************************************************************/
38 
43 #include <kaydaradef.h>
44 #ifndef FBSDK_DLL
45 
48  #define FBSDK_DLL K_DLLIMPORT
49 #endif
50 
51 #include <fbsdk/fbkeyinggroup.h>
52 #include <fbsdk/fbmodel.h>
53 
54 #ifdef FBSDKUseNamespace
55  namespace FBSDKNamespace {
56 #endif
57 
61 
64 {
69 };
70 FB_DEFINE_ENUM( FBSDK_DLL, PlotAllowed );
71 
74 {
78 };
79 FB_DEFINE_ENUM( FBSDK_DLL, SyncActivationAndVisibilityMode );
80 
83 {
89 };
90 FB_DEFINE_ENUM( FBSDK_DLL, CharacterExtensionStancePoseMode );
91 
92 FB_DEFINE_COMPONENT( FBSDK_DLL, CharacterExtension );
93 FB_DEFINE_LIST( FBSDK_DLL, CharacterExtension );
95 
98 {
102 };
103 FB_DEFINE_ENUM( FBSDK_DLL, CharacterExtensionRetargetMode );
104 
105 
109 {
110  public:
116  virtual FBCharacterExtension* operator[]( int pIndex );
117 };
118 
119 
120 
122 // FBGroup
124 
128 {
129  //--- Open Reality declaration.
131 public:
132 
133 
134 
135 
140  FBCharacterExtension(const char* pName, HIObject pObject=NULL);
141 
144  virtual void FBDelete() override;
145 
150  FBPropertyPlotAllowed PlotAllowed;
151  FBPropertyModel ReferenceModel;
152  FBPropertyCharacterExtensionRetargetMode RetargetMode;
153  FBPropertySyncActivationAndVisibilityMode SyncActivationAndVisibilityMode;
154  FBPropertyCharacterExtensionStancePoseMode StancePoseMode;
155 
156 
160 
164 
169 
170 
175 
180 
181 
186 
191 
192 
197 
203 
204 
210  void GetLabelNameWithExtensionObject( FBString& pLabelName, FBComponent* pObj, bool pReturnObjectNameIfNotFound = false );
211 
217 
218 
223 
228  void SetSourceExtension( FBCharacterExtension* pSourceExtension );
229 
234 
239  void SetSourceExtensionIndex( int pSrcExtIndex );
240 
241 
246 
252 
258 
264  void SetRetargetSourceProperty( int pPropIndex, FBProperty* pSourceProp );
265 
270  void RemoveRetargetSourceProperty( int pPropIndex );
271 
272 
276  void RetargetAnimation( FBEvaluateInfo* pEvalInfo );
277 };
278 
280 
281 #ifdef FBSDKUseNamespace
282  }
283 #endif
284 #endif /* this must be the last line of this file */
FBCharacterExtensionStancePoseMode
FBCharacterExtensionStancePoseMode
Definition: fbcharacterextension.h:83
kFBRetargetModeOff
@ kFBRetargetModeOff
Definition: fbcharacterextension.h:99
FBCharacterExtension::ReferenceModel
FBPropertyModel ReferenceModel
Read Write Property: Controls the referential of the extension.
Definition: fbcharacterextension.h:151
FBCharacterExtension::Label
FBPropertyString Label
Read Write Property: The logical name of the extension, use for mirroring.
Definition: fbcharacterextension.h:148
kFBPlotAllowed_None
@ kFBPlotAllowed_None
Definition: fbcharacterextension.h:65
FB_DEFINE_ENUM
#define FB_DEFINE_ENUM(DllTag, Type)
Define an enum and give it the ability to be a property.
Definition: fbproperties.h:150
FBCharacterExtension::PlotAllowed
FBPropertyPlotAllowed PlotAllowed
Read Write Property: Controls if objects in the set are transformable.
Definition: fbcharacterextension.h:150
FBCharacterExtension::GetRetargetReferenceProperty
FBProperty * GetRetargetReferenceProperty(int pPropIndex)
Return the reference property of the given index.
kFBStancePose_Selected
@ kFBStancePose_Selected
Definition: fbcharacterextension.h:85
FBPropertyInt
class K_DLLIMPORT FBPropertyBase< int, kFBPT_int > FBPropertyInt
Property: int
Definition: fbproperties.h:1331
FBCharacterExtensionRetargetMode
FBCharacterExtensionRetargetMode
Definition: fbcharacterextension.h:98
kFBStancePose_Reference_Selected
@ kFBStancePose_Reference_Selected
Definition: fbcharacterextension.h:86
FBCharacterExtension::IncludePartInBodyPart
FBPropertyBool IncludePartInBodyPart
Read Write Property: Include or not this extension when the Body Part mode is active.
Definition: fbcharacterextension.h:147
FBPropertyListCharacterExtension
Character extension property list.
Definition: fbcharacterextension.h:109
FBKeyingGroup
KeyingGroup class.
Definition: fbkeyinggroup.h:88
FBCharacterExtension::IncludePartInFullBody
FBPropertyBool IncludePartInFullBody
Read Write Property: Include or not this extension when the Full Body mode is active.
Definition: fbcharacterextension.h:146
FBCharacterExtension::SetRetargetSourceProperty
void SetRetargetSourceProperty(int pPropIndex, FBProperty *pSourceProp)
Set the source property for retargeting.
kFBPlotAllowed_Skeleton
@ kFBPlotAllowed_Skeleton
Definition: fbcharacterextension.h:66
kFBSyncMode_WithOthersThanControlRig
@ kFBSyncMode_WithOthersThanControlRig
Definition: fbcharacterextension.h:77
kFBSyncMode_WithContolRig
@ kFBSyncMode_WithContolRig
Definition: fbcharacterextension.h:76
kFBStancePose_Never
@ kFBStancePose_Never
Definition: fbcharacterextension.h:84
FBCharacterExtension::SyncActivationAndVisibilityMode
FBPropertySyncActivationAndVisibilityMode SyncActivationAndVisibilityMode
Read Write Property: The "Sync Activation & Visibility" mode.
Definition: fbcharacterextension.h:153
FBCharacterExtension::FBDelete
virtual void FBDelete() override
Virtual FBDelete function.
fbkeyinggroup.h
KeyingGroups interface for FBSDK.
kFBRetargetModeManual
@ kFBRetargetModeManual
Definition: fbcharacterextension.h:101
FBCharacterExtension::GetStancePose
FBObjectPose * GetStancePose()
Return stance pose.
FBCharacterExtension::GetMirrorExtension
FBCharacterExtension * GetMirrorExtension()
Return the character extension determined by MirrorLabel.
kFBPlotAllowed_ControlRig
@ kFBPlotAllowed_ControlRig
Definition: fbcharacterextension.h:67
FBCharacterExtension::StancePoseMode
FBPropertyCharacterExtensionStancePoseMode StancePoseMode
Read Write Property: Character extension stance pose mode.
Definition: fbcharacterextension.h:154
FBCharacterExtension::IsElementSelected
bool IsElementSelected()
Return true if one object in object dependency list is selected.
FBPropertyListCharacterExtension::operator[]
virtual FBCharacterExtension * operator[](int pIndex)
Get the CharacterExtension at pIndex.
FBSyncActivationAndVisibilityMode
FBSyncActivationAndVisibilityMode
Definition: fbcharacterextension.h:74
FBCharacterExtension::RetargetAnimation
void RetargetAnimation(FBEvaluateInfo *pEvalInfo)
RetargetAnimation.
FBCharacterExtension::SetSourceExtensionIndex
void SetSourceExtensionIndex(int pSrcExtIndex)
Set the enum that indicate which extension is used as a source during retargeting,...
FBCharacter
A character is the link between a motion source and a character model.
Definition: fbcharacter.h:1388
fbmodel.h
Base class for Cameras.
FBCharacterExtension::GetRetargetSourceProperty
FBProperty * GetRetargetSourceProperty(int pPropIndex)
Return the source property of the given index (the source property is the property that drives the re...
FBCharacterExtension
Objects Grouping class.
Definition: fbcharacterextension.h:128
FBString
Basic string class.
Definition: fbstring.h:67
kFBPlotAllowed_Both
@ kFBPlotAllowed_Both
Definition: fbcharacterextension.h:68
kFBRetargetModeAuto
@ kFBRetargetModeAuto
Definition: fbcharacterextension.h:100
__FBClassDeclare
#define __FBClassDeclare(Name, Parent)
For internal use only.
Definition: fbcomponent.h:131
FBProperty
Property: Base property class.
Definition: fbproperties.h:195
FBCharacterExtension::AddObjectProperties
void AddObjectProperties(FBComponent *pObj)
Add TR Properties from Object.
__FB_FORWARD
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:68
FBCharacterExtension::FBCharacterExtension
FBCharacterExtension(const char *pName, HIObject pObject=NULL)
Constructor.
FBCharacterExtension::RetargetMode
FBPropertyCharacterExtensionRetargetMode RetargetMode
Read Write Property: Character extension retarget mode.
Definition: fbcharacterextension.h:152
kFBStancePose_Always
@ kFBStancePose_Always
Definition: fbcharacterextension.h:88
FBPlotAllowed
FBPlotAllowed
Definition: fbcharacterextension.h:64
FBCharacterExtension::GetExtensionObjectWithLabelName
FBComponent * GetExtensionObjectWithLabelName(const FBString &pLabelName)
Find stored object based on label name.
kFBSyncMode_None
@ kFBSyncMode_None
Definition: fbcharacterextension.h:75
FBCharacterExtension::GoToStancePose
void GoToStancePose()
Reset object position to the stance.
FBCharacterExtension::MirrorLabel
FBPropertyInt MirrorLabel
Read Write Property: Enum that indicate which extension is used as mirror, 0 is none,...
Definition: fbcharacterextension.h:149
FBObjectPose
FBObjectPose class.
Definition: fbobjectpose.h:193
FBPropertyBool
class K_DLLIMPORT FBPropertyBase< bool, kFBPT_bool > FBPropertyBool
Property: bool
Definition: fbproperties.h:1308
FBSDK_DLL
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
Definition: fbcharacterextension.h:48
FB_DEFINE_LIST
#define FB_DEFINE_LIST(DllTag, Type)
Define a component list.
Definition: fbproperties.h:163
FBCharacterExtension::IsPropertyIncluded
bool IsPropertyIncluded(FBProperty *pProp)
Return true if the property is in character extension.
FBCharacterExtension::GetSourceExtension
FBCharacterExtension * GetSourceExtension()
Return the character extension that is used to drive this extension during retargeting.
FBPropertyListComponent
PropertyList: Concrete class for PropertyList of component
Definition: fbcomponent.h:536
FBCharacterExtension::SetSourceExtension
void SetSourceExtension(FBCharacterExtension *pSourceExtension)
Set the character extension to drive this extension during retargeting.
FB_FORWARD
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:62
FBCharacterExtension::GetCharacter
FBCharacter * GetCharacter()
Return the attached Character.
FBCharacterExtension::RemoveRetargetSourceProperty
void RemoveRetargetSourceProperty(int pPropIndex)
Remove the source property for retargeting.
FB_DEFINE_COMPONENT
FB_DEFINE_COMPONENT(K_DLLIMPORT, AnimationNode)
Animation node class.
FBCharacterExtension::UpdateStancePose
void UpdateStancePose()
Update the stance pose to the current position of the character extension element.
FBCharacterExtension::RemoveObjectAndProperties
void RemoveObjectAndProperties(FBComponent *pObj)
Remove TR Properties from Object.
FBCharacterExtension::GetRetargetPropertyCount
int GetRetargetPropertyCount()
Return the total number of retarget properties.
FBEvaluateInfo
AnimationNodeNotify evaluation information.
Definition: fbevaluateinfo.h:79
FBPropertyString
Property class: const char * (String).
Definition: fbproperties.h:1281
FBCharacterExtension::GetSourceExtensionIndex
int GetSourceExtensionIndex()
Return the enum that indicate which extension is used as a source during retargeting,...
FBComponent
MotionBuilder SDK base class.
Definition: fbcomponent.h:651
FBCharacterExtension::GetLabelNameWithExtensionObject
void GetLabelNameWithExtensionObject(FBString &pLabelName, FBComponent *pObj, bool pReturnObjectNameIfNotFound=false)
Find the label name that was used to store object pose.
kFBStancePose_Self_Or_Reference_Selected
@ kFBStancePose_Self_Or_Reference_Selected
Definition: fbcharacterextension.h:87