Open Reality Reference Guide
fbgroup.h
Go to the documentation of this file.
1 #ifndef __FBGROUP_H__
2 #define __FBGROUP_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/fbcore.h>
52 
53 #ifdef FBSDKUseNamespace
54  namespace FBSDKNamespace {
55 #endif
56 
61 
64 
68 {
69 public:
75  FBGroup* operator[](int pIndex);
76 };
77 
81 {
82 public:
88  FBSet* operator[](int pIndex);
89 };
90 
92 // FBGroup
94 
97 class FBSDK_DLL FBGroup : public FBBox
98 {
99  //--- Open Reality declaration.
101 public:
102 
107  FBGroup(const char* pName, HIObject pObject=NULL);
108 
111  virtual void FBDelete() override;
112 
118 
122  void Select(bool pSelect);
123 
128  bool Contains(FBComponent* pComponent);
129 
134 };
135 
137 // FBSet
139 
144 class FBSDK_DLL FBSet : public FBBox
145 {
146  //--- Open Reality declaration.
148 public:
149 
154  FBSet(const char* pName, HIObject pObject=NULL);
155 
158  virtual void FBDelete() override;
159 
163  void Select(bool pSelect);
164 
169  int Contains(FBComponent* pComponent);
170 
175 };
176 
178 
179 #ifdef FBSDKUseNamespace
180  }
181 #endif
182 #endif /* this must be the last line of this file */
FBGroup::Pickable
FBPropertyBool Pickable
Read Write Property: Controls if objects in the group are pickable.
Definition: fbgroup.h:131
FBGroup::FBDelete
virtual void FBDelete() override
Virtual FBDelete function.
FBPropertyListSet::operator[]
FBSet * operator[](int pIndex)
Get the set at pIndex.
FBGroup::Show
FBPropertyBool Show
Read Write Property: Controls if objects in the group are displayed.
Definition: fbgroup.h:130
FBSet::Items
FBPropertyListComponent Items
List: Items in the set.
Definition: fbgroup.h:174
FBGroup
Objects Grouping class.
Definition: fbgroup.h:98
FBBox
A box is a fundamental building block in the application architecture.
Definition: fbcore.h:218
FBGroup::Clone
FBGroup * Clone()
Clone the group.
FBGroup::Contains
bool Contains(FBComponent *pComponent)
Contains.
FBSet::Select
void Select(bool pSelect)
Select.
FBGroup::Select
void Select(bool pSelect)
Select.
FBPropertyListGroup
List: Group
Definition: fbgroup.h:68
FBSet::FBSet
FBSet(const char *pName, HIObject pObject=NULL)
Constructor.
FBSDK_DLL
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
Definition: fbgroup.h:48
FBSet::Transformable
FBPropertyBool Transformable
Read Write Property: Controls if objects in the set are transformable.
Definition: fbgroup.h:173
FBPropertyListGroup::operator[]
FBGroup * operator[](int pIndex)
Get the group at pIndex.
FBGroup::Items
FBPropertyListComponent Items
List: Items in the group.
Definition: fbgroup.h:133
__FBClassDeclare
#define __FBClassDeclare(Name, Parent)
For internal use only.
Definition: fbcomponent.h:131
__FB_FORWARD
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:68
FBSet
Objects Set class.
Definition: fbgroup.h:145
FBPropertyListSet
List: Set
Definition: fbgroup.h:81
FBPropertyBool
class K_DLLIMPORT FBPropertyBase< bool, kFBPT_bool > FBPropertyBool
Property: bool
Definition: fbproperties.h:1308
FBGroup::Transformable
FBPropertyBool Transformable
Read Write Property: Controls if objects in the group are transformable.
Definition: fbgroup.h:132
FBPropertyListComponent
PropertyList: Concrete class for PropertyList of component
Definition: fbcomponent.h:536
fbcore.h
Contains definitions for devices, boxes and models.
FB_FORWARD
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition: fbtypes.h:62
FBSet::FBDelete
virtual void FBDelete() override
Virtual FBDelete function.
FB_DEFINE_COMPONENT
FB_DEFINE_COMPONENT(K_DLLIMPORT, AnimationNode)
Animation node class.
FBSet::Visibility
FBPropertyAnimatableBool Visibility
Read Write Property: Visibility of set (animatable).
Definition: fbgroup.h:171
FBSet::Pickable
FBPropertyBool Pickable
Read Write Property: Controls if objects in the set are pickable.
Definition: fbgroup.h:172
FBPropertyAnimatableBool
class K_DLLIMPORT FBPropertyBaseAnimatable< bool, kFBPT_bool > FBPropertyAnimatableBool
FBPropertyAnimatableBool type definition.
Definition: fbproperties.h:1732
FBComponent
MotionBuilder SDK base class.
Definition: fbcomponent.h:651
FBGroup::FBGroup
FBGroup(const char *pName, HIObject pObject=NULL)
Constructor.
FBSet::Contains
int Contains(FBComponent *pComponent)
Contains.