fbsdk/fbkeyinggroup.h Source File
 
 
 
fbsdk/fbkeyinggroup.h
Go to the documentation of this file.
00001 #ifndef __FBKEYINGGROUP_H__
00002 #define __FBKEYINGGROUP_H__
00003 /**************************************************************************
00004 Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
00005 All Rights Reserved.
00006 
00007 The coded instructions, statements, computer programs, and/or related 
00008 material (collectively the "Data") in these files contain unpublished 
00009 information proprietary to Autodesk, Inc. and/or its licensors, which is 
00010 protected by Canada and United States of America federal copyright law 
00011 and by international treaties.
00012 
00013 The Data may not be disclosed or distributed to third parties, in whole 
00014 or in part, without the prior written consent of Autodesk, Inc. 
00015 ("Autodesk").
00016 
00017 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00018 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
00019 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
00020 ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
00021 OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
00022 PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
00023 WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
00024 FREE.
00025 
00026 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
00027 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
00028 EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
00029 DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
00030 OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
00031 DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
00032 LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
00033 LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
00034 DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
00035 BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
00036 
00037 **************************************************************************/
00038 
00043 #include <kaydaradef.h>
00044 #ifndef FBSDK_DLL 
00045 
00048 #define FBSDK_DLL K_DLLIMPORT
00049 #endif
00050 
00051 #include <fbsdk/fbcomponent.h>
00052 
00053 #ifdef FBSDKUseNamespace
00054 namespace FBSDKNamespace {
00055 #endif
00056 
00057     __FB_FORWARD( FBKeyingGroup );
00058     FB_DEFINE_COMPONENT( FBSDK_DLL, KeyingGroup );
00059     FB_DEFINE_LIST( FBSDK_DLL, KeyingGroup );
00060 
00062     enum FBKeyingGroupType {    
00063         kFBKeyingGroupGlobal,           
00064         kFBKeyingGroupObjectType,       
00065         kFBKeyingGroupLocal         
00066     };
00067 
00069     // FBKeyingGroup
00071 
00087     class FBSDK_DLL FBKeyingGroup : public FBComponent
00088     {
00089         //--- Open Reality declaration.
00090         __FBClassDeclare(FBKeyingGroup, FBComponent);
00091     public:
00092 
00098         FBKeyingGroup(const char* pName, FBKeyingGroupType pType, HIObject pObject=NULL);
00099 
00102         virtual void FBDelete();
00103 
00107         void SetObjectType(FBComponent* pObject);
00108 
00112         void AddProperty(FBProperty* pProp);
00116         void RemoveProperty(FBProperty* pProp); 
00117 
00122         FBProperty* GetProperty(int pIndex); 
00123 
00127         int GetPropertyCount();
00128 
00133         int FindPropertyIndex( FBProperty* pProp ); 
00134 
00138         void    AddObjectDependency(FBComponent* pObj);
00139 
00143         void    RemoveObjectDependency(FBComponent* pObj); 
00144 
00149         bool    IsObjectDependency(FBComponent* pObj);
00150 
00154         bool    IsObjectDependencySelected();
00155 
00158         void    RemoveAllProperties();
00161         void    RemoveAllObjectDependency();
00162 
00165         void    RemoveAllSubKeyingGroup();
00166 
00170         int                 GetParentKeyingGroupCount();
00175         FBKeyingGroup*      GetParentKeyingGroup(int pIndex);
00179         int                 GetSubKeyingGroupCount();
00184         FBKeyingGroup*      GetSubKeyingGroup(int pIndex);
00188         int                 GetSubObjectCount();
00193         FBComponent*        GetSubObject(int pIndex);
00194 
00199         int                 GetCumulativePropertyCount( bool pStopAtVisible = false );
00205         FBProperty*                     GetCumulativeProperty( int pIndex, bool pStopAtVisible = false );
00206 
00209         void ClearAllItems();
00210 
00211 
00214         void SetEnabled(bool pEnable);
00215 
00218         void SetActive(bool pActive);
00219 
00222         void SetActiveAppend(bool pActive);
00223     };
00224 
00226     // FBPropertyListKeyingGroup
00228     FB_DEFINE_LIST( FBSDK_DLL, KeyingGroup );
00229     FB_FORWARD( FBPropertyListKeyingGroup );
00230 
00232     class FBSDK_DLL FBPropertyListKeyingGroup : public FBPropertyListComponent
00233     {
00234     public:
00235         FBPropertyListKeyingGroup();
00240         FBKeyingGroup* operator[](int pIndex);
00241     };
00242 
00244 
00245 #ifdef FBSDKUseNamespace
00246 }
00247 #endif
00248 #endif /* this must be the last line of this file */