fbsdk/fbcharacterextension.h Source File

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 
58 __FB_FORWARD( FBCharacterExtension );
59 __FB_FORWARD( FBCharacter );
60 __FB_FORWARD( FBObjectPose );
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();
145 
154 
155 
158  void UpdateStancePose();
159 
162  void GoToStancePose();
163 
167  FBObjectPose* GetStancePose();
168 
169 
173  FBCharacterExtension* GetMirrorExtension();
174 
178  FBCharacter* GetCharacter();
179 
180 
184  void AddObjectProperties( FBComponent* pObj );
185 
189  void RemoveObjectAndProperties( FBComponent* pObj );
190 
191 
195  bool IsElementSelected();
196 
201  bool IsPropertyIncluded( FBProperty* pProp );
202 
203 
209  void GetLabelNameWithExtensionObject( FBString& pLabelName, FBComponent* pObj, bool pReturnObjectNameIfNotFound = false );
210 
215  FBComponent* GetExtensionObjectWithLabelName( const FBString& pLabelName );
216 
217 
221  FBCharacterExtension* GetSourceExtension();
222 
227  void SetSourceExtension( FBCharacterExtension* pSourceExtension );
228 
232  int GetSourceExtensionIndex();
233 
238  void SetSourceExtensionIndex( int pSrcExtIndex );
239 
240 
244  int GetRetargetPropertyCount();
245 
250  FBProperty* GetRetargetReferenceProperty( int pPropIndex );
251 
256  FBProperty* GetRetargetSourceProperty( int pPropIndex );
257 
263  void SetRetargetSourceProperty( int pPropIndex, FBProperty* pSourceProp );
264 
269  void RemoveRetargetSourceProperty( int pPropIndex );
270 
271 
275  void RetargetAnimation( FBEvaluateInfo* pEvalInfo );
276 };
277 
279 
280 #ifdef FBSDKUseNamespace
281  }
282 #endif
283 #endif /* this must be the last line of this file */
Property: Base property class.
Definition: fbproperties.h:192
KeyingGroups interface for FBSDK.
KeyingGroup class.
Definition: fbkeyinggroup.h:87
#define __FBClassDeclare(Name, Parent)
For internal use only.
Definition: fbcomponent.h:132
FBCharacterExtensionRetargetMode
Character extension Retarget Mode.
#define FB_DEFINE_COMPONENT(DllTag, Type)
Define a component and give it the ability to be a property.
Definition: fbproperties.h:139
#define FB_DEFINE_LIST(DllTag, Type)
Define a component list.
Definition: fbproperties.h:161
Character extension will never go in stance pose.
Property class: const char * (String).
class FBPropertyBaseEnum< enum FBCharacterExtensionRetargetMode > FBPropertyCharacterExtensionRetargetMode
Basic string class.
Definition: fbstring.h:66
FBPropertyModel ReferenceModel
Read Write Property: Controls the referential of the extension.
Character extension will always go in stance pose.
class FBPropertyBaseComponent< FBModel * > FBPropertyModel
Definition: fbcore.h:70
#define NULL
Definition: kaydara.h:179
class FBPropertyBase< int, kFBPT_int > FBPropertyInt
Property: int
FBPropertyCharacterExtensionRetargetMode RetargetMode
Read Write Property: Character extension retarget mode.
Base class for Cameras.
FBCharacterExtensionStancePoseMode
Character Extension Stance Pose mode when the stance pose is activated on a character.
#define FB_DEFINE_ENUM(DllTag, Type)
Define an enum and give it the ability to be a property.
Definition: fbproperties.h:148
No particular sync activity.
FBPropertyInt MirrorLabel
Read Write Property: Enum that indicate which extension is used as mirror, 0 is none, 1 is self, 2-n represent the (ith - 2)character extension in the attached character excluding self.
Character extension will go in stance pose if its reference is selected.
Character extension will go in stance pose if it is selected or if its reference is selected...
PropertyList: Concrete class for PropertyList of component
Definition: fbcomponent.h:549
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:68
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
FBPropertyBool IncludePartInFullBody
Read Write Property: Include or not this extension when fullBody is active.
Enable Constraints' Activeness and Models' visibility when the attached character is driven by its co...
#define FBSDKNamespace
FBSDKNamespace define.
Definition: fbversion.h:64
Character extension will go in stance pose if it is selected.
Character extension property list.
FBPropertyCharacterExtensionStancePoseMode StancePoseMode
Read Write Property: Character extension stance pose mode.
MotionBuilder SDK base class.
Definition: fbcomponent.h:664
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:62
FBPlotAllowed
FBPlotAllowed.
class FBPropertyBaseEnum< enum FBPlotAllowed > FBPropertyPlotAllowed
Enable Constraints' Activeness and Models' visibility when the attached character is driven by someth...
A character is the link between a motion source and a character model.
Definition: fbcharacter.h:1364
class FBPropertyBaseEnum< enum FBSyncActivationAndVisibilityMode > FBPropertySyncActivationAndVisibilityMode
AnimationNodeNotify evaluation information.
class FBPropertyBaseEnum< enum FBCharacterExtensionStancePoseMode > FBPropertyCharacterExtensionStancePoseMode
FBObjectPose class.
Definition: fbobjectpose.h:192
FBPropertySyncActivationAndVisibilityMode SyncActivationAndVisibilityMode
Read Write Property: The "Sync Activation & Visibility" mode.
FBSyncActivationAndVisibilityMode
Sync mode for Constraints' Activeness and Models' visibility belonging to the Character Extension...
FBPropertyString Label
Read Write Property: The logical name of the extension, use for mirroring.
FBPropertyPlotAllowed PlotAllowed
Read Write Property: Controls if objects in the set are transformable.
class FBPropertyBase< bool, kFBPT_bool > FBPropertyBool
Property: bool