FBX SDK Reference Guide: kfbxlayercontainer.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXLAYERCONTAINER_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXLAYERCONTAINER_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 <fbxfilesdk/components/kbaselib/kaydaradef_h.h>
00043 #include <fbxfilesdk/components/kbaselib/kaydara.h>
00044 
00045 #include <fbxfilesdk/kfbxplugins/kfbxnodeattribute.h>
00046 #include <fbxfilesdk/kfbxplugins/kfbxlayer.h>
00047 
00048 #include <fbxfilesdk/components/kbaselib/klib/karrayul.h>
00049 
00050 #include <fbxfilesdk/kfbxmath/kfbxvector4.h>
00051 
00052 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00053 
00054 class KFbxSdkManager;
00055 
00056 
00069 class KFBX_DLL KFbxLayerContainer : public KFbxNodeAttribute
00070 {
00071     KFBXOBJECT_DECLARE(KFbxLayerContainer,KFbxNodeAttribute);
00072 public:
00073 
00077     virtual EAttributeType GetAttributeType() const { return eUNIDENTIFIED; } 
00078 
00083 
00087     int CreateLayer();
00088 
00090     void ClearLayers();
00091 
00095     int GetLayerCount() const;
00096 
00102     int GetLayerCount(KFbxLayerElement::ELayerElementType pType,  bool pUVCount=false) const;
00103 
00108     KFbxLayer* GetLayer(int pIndex);
00109 
00114     KFbxLayer const* GetLayer(int pIndex) const;
00115 
00122     KFbxLayer* GetLayer(int pIndex, KFbxLayerElement::ELayerElementType pType, bool pIsUV=false);
00123 
00130     KFbxLayer const* GetLayer(int pIndex, KFbxLayerElement::ELayerElementType pType, bool pIsUV=false) const;
00131 
00140     int GetLayerIndex(int pIndex, KFbxLayerElement::ELayerElementType pType, bool pIsUV=false) const;
00141 
00148     int GetLayerTypedIndex(int pGlobalIndex, KFbxLayerElement::ELayerElementType pType, bool pIsUV=false);
00150 
00155     bool ConvertDirectToIndexToDirect(int pLayer);
00156 
00158 //
00159 //  WARNING!
00160 //
00161 //  Anything beyond these lines may not be documented accurately and is 
00162 //  subject to change without notice.
00163 //
00165 
00166 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00167 
00168     int  GTC(kUInt i, int j);
00169     void* GT (int  i,    kUInt l, int j); 
00170     int  AT (void* t,    kUInt l, int j);
00171     int  GTI(char const* n, kUInt l, int j);
00172     int  GMC(kUInt i, void* n = NULL);
00173     void* GM (int  i,    kUInt l, void* n = NULL);
00174     int  AM (void* m,    kUInt l, void* n = NULL);
00175     int  GMI(char const* n, kUInt l, void* d = NULL);
00176 
00177     int AddToLayerElementsList(KFbxLayerElement* pLEl);
00178     void RemoveFromLayerElementsList(KFbxLayerElement* pLEl);
00179 
00180 protected:
00181 
00182     KFbxLayerContainer(KFbxSdkManager& pManager, char const* pName);
00183     virtual ~KFbxLayerContainer();
00184 
00185     void CopyLayers(KFbxLayerContainer const* pLayerContainer);
00186     KFbxLayerContainer& operator=(KFbxLayerContainer const& pLayerContainer);
00187 
00188     virtual void SetDocument(KFbxDocument* pDocument);
00189     virtual bool ConnecNotify (KFbxConnectEvent const &pEvent);
00190 
00191     KArrayTemplate<KFbxLayer*> mLayerArray;
00192     KArrayTemplate<KFbxLayerElement*> mLayerElementsList;
00193 
00194     friend class KFbxScene;
00195     friend class KFbxGeometryConverter;
00196 
00197 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00198 
00199 };
00200 
00201 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00202 
00203 #endif // FBXFILESDK_KFBXPLUGINS_KFBXLAYERCONTAINER_H
00204