FBX SDK Reference Guide: kfbxlayercontainer.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_LAYER_CONTAINER_H_
00005 #define _FBXSDK_LAYER_CONTAINER_H_
00006 
00007 /**************************************************************************************
00008 
00009  Copyright © 2001 - 2008 Autodesk, Inc. and/or its licensors.
00010  All Rights Reserved.
00011 
00012  The coded instructions, statements, computer programs, and/or related material 
00013  (collectively the "Data") in these files contain unpublished information 
00014  proprietary to Autodesk, Inc. and/or its licensors, which is protected by 
00015  Canada and United States of America federal copyright law and by international 
00016  treaties. 
00017  
00018  The Data may not be disclosed or distributed to third parties, in whole or in
00019  part, without the prior written consent of Autodesk, Inc. ("Autodesk").
00020 
00021  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00022  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
00023  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR ARISING
00024  BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES OF TITLE, 
00025  NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OR USE. 
00026  WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT WARRANT THAT THE OPERATION
00027  OF THE DATA WILL BE UNINTERRUPTED OR ERROR FREE. 
00028  
00029  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
00030  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR EXPENSES
00031  OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE DAMAGES OR OTHER
00032  SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS OF PROFITS, REVENUE
00033  OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR DAMAGES OF ANY KIND),
00034  HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF LIABILITY, WHETHER DERIVED
00035  FROM CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO, NEGLIGENCE), OR OTHERWISE,
00036  ARISING OUT OF OR RELATING TO THE DATA OR ITS USE OR ANY OTHER PERFORMANCE,
00037  WHETHER OR NOT AUTODESK HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS
00038  OR DAMAGE. 
00039 
00040 **************************************************************************************/
00041 
00042 #include <kaydaradef.h>
00043 #ifndef KFBX_DLL 
00044     #define KFBX_DLL K_DLLIMPORT
00045 #endif
00046 
00047 #include <kaydara.h>
00048 
00049 #include <kfbxplugins/kfbxnodeattribute.h>
00050 #include <kfbxplugins/kfbxlayer.h>
00051 
00052 #include <klib/karrayul.h>
00053 
00054 #include <kfbxmath/kfbxvector4.h>
00055 
00056 #include <fbxfilesdk_nsbegin.h>
00057 
00058 class KFbxSdkManager;
00059 
00060 
00073 class KFBX_DLL KFbxLayerContainer : public KFbxNodeAttribute
00074 {
00075     KFBXOBJECT_DECLARE(KFbxLayerContainer,KFbxNodeAttribute);
00076 public:
00077 
00081     virtual EAttributeType GetAttributeType() const { return eUNIDENTIFIED; } 
00082 
00087 
00091     int CreateLayer();
00092 
00094     void ClearLayers();
00095 
00099     int GetLayerCount() const;
00100 
00106     int GetLayerCount(KFbxLayerElement::ELayerElementType pType,  bool pUVCount=false) const;
00107 
00112     KFbxLayer* GetLayer(int pIndex);
00113 
00118     KFbxLayer const* GetLayer(int pIndex) const;
00119 
00126     KFbxLayer* GetLayer(int pIndex, KFbxLayerElement::ELayerElementType pType, bool pIsUV=false);
00127 
00134     KFbxLayer const* GetLayer(int pIndex, KFbxLayerElement::ELayerElementType pType, bool pIsUV=false) const;
00135 
00144     int GetLayerIndex(int pIndex, KFbxLayerElement::ELayerElementType pType, bool pIsUV=false) const;
00145 
00152     int GetLayerTypedIndex(int pGlobalIndex, KFbxLayerElement::ELayerElementType pType, bool pIsUV=false);
00154 
00159     bool ConvertDirectToIndexToDirect(int pLayer);
00160 
00162 //
00163 //  WARNING!
00164 //
00165 //  Anything beyond these lines may not be documented accurately and is 
00166 //  subject to change without notice.
00167 //
00169 
00170 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00171 
00172     int  GTC(kUInt i, int j);
00173     void* GT (int  i,    kUInt l, int j); 
00174     int  AT (void* t,    kUInt l, int j);
00175     int  GTI(char const* n, kUInt l, int j);
00176     int  GMC(kUInt i, void* n = NULL);
00177     void* GM (int  i,    kUInt l, void* n = NULL);
00178     int  AM (void* m,    kUInt l, void* n = NULL);
00179     int  GMI(char const* n, kUInt l, void* d = NULL);
00180 
00181     int AddToLayerElementsList(KFbxLayerElement* pLEl);
00182     void RemoveFromLayerElementsList(KFbxLayerElement* pLEl);
00183 
00184 protected:
00185 
00186     KFbxLayerContainer(KFbxSdkManager& pManager, char const* pName);
00187     virtual ~KFbxLayerContainer();
00188 
00189     void CopyLayers(KFbxLayerContainer const* pLayerContainer);
00190     KFbxLayerContainer& operator=(KFbxLayerContainer const& pLayerContainer);
00191 
00192     virtual void SetDocument(KFbxDocument* pDocument);
00193     virtual bool ConnecNotify (KFbxConnectEvent const &pEvent);
00194 
00195     KArrayTemplate<KFbxLayer*> mLayerArray;
00196     KArrayTemplate<KFbxLayerElement*> mLayerElementsList;
00197 
00198     friend class KFbxScene;
00199     friend class KFbxGeometryConverter;
00200     friend class KFbxWriterFbx6;
00201 
00202 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00203 
00204 };
00205 
00206 #include <fbxfilesdk_nsend.h>
00207 
00208 #endif // #ifndef _FBXSDK_LAYER_CONTAINER_H_
00209 
00210