Open Reality Reference Guide
fbtoollayoutmanager.h
Go to the documentation of this file.
1 #ifndef __FBTOOLLAYOUTMANAGER_H__
2 #define __FBTOOLLAYOUTMANAGER_H__
3 /**************************************************************************
4 Copyright (c) 1994 - 2019 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 
45 #include <kaydaradef.h>
46 #ifndef FBSDK_DLL
50 #define FBSDK_DLL K_DLLIMPORT
51 #endif
52 
53 #include <fbsdk/fbcomponent.h>
54 
55 #ifdef FBSDKUseNamespace
56 namespace FBSDKNamespace {
57 #endif //FBSDKUseNamespace
58 
60 
63 
104 {
106 
107 protected:
112 
113 public:
114 
119 
124 
129  const char* GetLayoutName( int pLayoutIdx );
130 
135 
139  const char* GetCurrentLayoutName();
140 
145  bool SetCurrentLayout( int pLayoutIdx );
146 
151  bool SetCurrentLayout( const char* pLayoutName );
152 
157  const char* CreateLayout( const char* pLayoutName );
158 
163  bool DeleteLayout( int pLayoutIdx );
164 
169  bool DeleteLayout( const char* pLayoutName );
170 
175 
181  const char* RenameLayout( const char* pOldLayoutName, const char* pNewLayoutName );
182 
187 
192  bool SetAutoUpdateLayout( bool pAutoUpdate );
193 
200 
207  bool SetPreventDocking( bool pPreventDocking );
208 
213 };
214 
215 #ifdef FBSDKUseNamespace
216 }
217 #endif //FBSDKUseNamespace
218 
219 #endif //__FBTOOLLAYOUTMANAGER_H__
MotionBuilder SDK base class.
Definition: fbcomponent.h:651
Story Track class.
Definition: fbstory.h:643
Tool Layout Manager class.
bool SetPreventDocking(bool pPreventDocking)
Set the 'Prevent Docking' state value.
int GetFactoryLayoutCount()
Get the number of factory layouts.
bool GetAutoUpdateLayout()
Get the 'Auto-update Layout' state value.
bool SetCurrentLayout(const char *pLayoutName)
Set the current layout from the given layout name.
int GetCustomLayoutCount()
Get the number of custom layouts.
bool DeleteLayout(int pLayoutIdx)
Delete the layout associated with the given layout index.
bool SetCurrentLayout(int pLayoutIdx)
Set the current layout from the given layout index.
static FBToolLayoutManager & TheOne()
Returns the only instance of FBToolLayoutManager.
bool GetPreventDocking()
Get the 'Prevent Docking' state value.
bool UpdateCurrentLayout()
Update the current layout from the current layout state.
FBToolLayoutManager()
Constructor.
bool SetAutoUpdateLayout(bool pAutoUpdate)
Set the 'Auto-update Layout' state value.
const char * GetCurrentLayoutName()
Get the name of the current layout.
const char * CreateLayout(const char *pLayoutName)
Create a new layout from the current layout state.
const char * RenameLayout(const char *pOldLayoutName, const char *pNewLayoutName)
Rename a layout.
const char * GetLayoutName(int pLayoutIdx)
Get the layout name associated with the given layout index.
int GetCurrentLayoutIdx()
Get the layout index of the current layout.
bool DeleteLayout(const char *pLayoutName)
Delete the layout with the given layout name.
Basic class definitions.
FB_DEFINE_COMPONENT(K_DLLIMPORT, AnimationNode)
Animation node class.
#define FBClassDeclare(Name, Parent)
Class declaration.
Definition: fbdefines.h:85
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:62