FBX SDK Reference Guide: kfbxcollection.h Source File
00001 #ifndef _FBXSDK_COLLECTION_H_
00002 #define _FBXSDK_COLLECTION_H_
00003 
00004 /**************************************************************************************
00005 
00006  Copyright  2001 - 2008 Autodesk, Inc. and/or its licensors.
00007  All Rights Reserved.
00008 
00009  The coded instructions, statements, computer programs, and/or related material 
00010  (collectively the "Data") in these files contain unpublished information 
00011  proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00012  Canada and United States of America federal copyright law and by international 
00013  treaties. 
00014  
00015  The Data may not be disclosed or distributed to third parties, in whole or in
00016  part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00017 
00018  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00019  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00020  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00021  BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00022  NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00023  WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00024  OF THE DATA WILL BE UNINTERRUPTED OR ERROR 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 EXPENSES
00028  OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00029  SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00030  OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00031  HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00032  FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00033  ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00034  WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00035  OR DAMAGE. 
00036 
00037 **************************************************************************************/
00038 
00039 #include <kaydaradef.h>
00040 #ifndef KFBX_DLL
00041     #define KFBX_DLL K_DLLIMPORT
00042 #endif
00043 
00044 // FBX includes
00045 
00046 #include <kfbxplugins/kfbxobject.h>
00047 #include <kfbxplugins/kfbxsdkmanager.h>
00048 
00049 #include <kfbxevents/kfbxevents.h>
00050 
00051 #include <klib/kerror.h>
00052 
00053 #include <fbxfilesdk_nsbegin.h>
00054 
00055     class KFbxCriteria;
00056 
00062     class KFBX_DLL KFbxCollection : public KFbxObject
00063     {
00064         KFBXOBJECT_DECLARE(KFbxCollection,KFbxObject);
00065 
00070         public:
00072             virtual void    Clear();
00074             inline  void    AddMember(KFbxObject *pMember)      { ConnectSrcObject(pMember); }
00076             inline  void    RemoveMember(KFbxObject *pMember)   { DisconnectSrcObject(pMember); }
00078             template <class T> inline T *       FindMember(T const *pfbxType, const char *pName) { return FindSrcObject(pfbxType, pName); }
00079 
00081             inline int                          GetMemberCount () const { return GetSrcObjectCount(); }
00083             template < class T > inline int     GetMemberCount (T const *pFBX_TYPE) const { return GetSrcObjectCount(T::ClassId); }
00084             int                                 GetMemberCount( KFbxCriteria pCriteria ) const;
00085 
00087             inline KFbxObject*                  GetMember (int pIndex=0) const                  { return GetSrcObject(pIndex); }
00089             template < class T > inline T*      GetMember (T const *pFBX_TYPE, int pIndex=0) const  { return (T *)GetSrcObject(T::ClassId,pIndex); }
00090             KFbxObject*                         GetMember (KFbxCriteria pCriteria, int pIndex=0) const;
00092 
00093             virtual bool    IsMember(KFbxObject *pMember) const;
00095 
00100         public:
00102             virtual void    SetSelectedAll(bool pSelection);
00104             virtual void    SetSelected(KFbxObject* pObject,bool pSelection);
00106             virtual bool    GetSelected(KFbxObject* pSelection);
00108 
00110     //  WARNING!
00111     //  Anything beyond these lines may not be Collectioned accurately and is
00112     //  subject to change without notice.
00114     #ifndef DOXYGEN_SHOULD_SKIP_THIS
00115 
00116         // Constructor / Destructor
00117         protected:
00118             virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType) const;
00119             KFbxCollection(KFbxSdkManager& pManager, char const* pName);
00120             ~KFbxCollection();
00121             virtual void Construct  (const KFbxCollection* pFrom);
00122             virtual void Destruct   (bool pRecursive, bool pDependents);
00123 
00124 
00125     #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00126 
00127     };
00128 
00129 #include <fbxfilesdk_nsend.h>
00130 
00131 #endif // #ifndef _FBXSDK_Collection_H_
00132 
00133