FBX SDK Reference Guide: kfbxlodgroup.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXLODGROUP_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXLODGROUP_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 
00047 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00048 
00049 class KFbxSdkManager;
00050 
00054 class KFBX_DLL KFbxLodGroup : public KFbxNodeAttribute
00055 {
00056     KFBXOBJECT_DECLARE(KFbxLodGroup,KFbxNodeAttribute);
00057 
00058 public:
00060     virtual EAttributeType GetAttributeType() const;
00061 
00066     static const char*          sMinMaxDistance;
00067     static const char*          sMinDistance;
00068     static const char*          sMaxDistance;
00069     static const char*          sThresholds;
00070     static const char*          sWorldSpace;
00071     static const char*          sDisplayLevels;
00073 
00078     static const fbxBool1      sDefaultMinMaxDistance;
00079     static const fbxDouble1    sDefaultMinDistance;
00080     static const fbxDouble1    sDefaultMaxDistance;
00081     static const fbxBool1      sDefaultWorldSpace;
00083 
00089     typedef enum {
00090         eUseLOD,
00091         eShow,
00092         eHide
00093     } EDisplayLevel;
00094 
00096     //
00097     // Properties
00098     //
00100 
00108     KFbxTypedProperty<fbxBool1>       MinMaxDistance;
00109 
00117     KFbxTypedProperty<fbxDouble1>     MinDistance;
00118 
00126     KFbxTypedProperty<fbxDouble1>     MaxDistance;
00127 
00135     KFbxTypedProperty<fbxBool1>       WorldSpace;
00136 
00137 
00139     //
00140     // Methods
00141     //
00143 
00147     int GetNumThresholds() const;
00148 
00158     bool AddThreshold(fbxDistance pThreshValue);
00159 
00165     bool SetThreshold(int pEl, fbxDistance pThreshValue);
00166 
00173     bool GetThreshold(int pEl, fbxDistance& pThreshValue);
00174 
00175 
00179     int GetNumDisplayLevels() const;
00180 
00190     bool AddDisplayLevel(KFbxLodGroup::EDisplayLevel pValue);
00191 
00197     bool SetDisplayLevel(int pEl, KFbxLodGroup::EDisplayLevel pValue);
00198 
00205     bool GetDisplayLevel(int pEl, KFbxLodGroup::EDisplayLevel& pValue);
00206     
00208 //
00209 //  WARNING!
00210 //
00211 //  Anything beyond these lines may not be documented accurately and is
00212 //  subject to change without notice.
00213 //
00215 
00216 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00217 
00218 public:
00219     // Clone
00220     virtual KFbxObject* Clone(KFbxObject* pContainer, KFbxObject::ECloneType pCloneType = eDEEP_CLONE) const;
00221 
00222 protected:
00223 
00224     KFbxLodGroup(KFbxSdkManager& pManager, char const* pName);
00225     ~KFbxLodGroup();
00226 
00227     virtual void Construct(const KFbxLodGroup* pFrom);
00228     virtual bool ConstructProperties(bool pForceSet);
00229     virtual void Destruct(bool pRecursive, bool pDependents);
00230 
00232     KFbxLodGroup& operator=(KFbxLodGroup const& pLodGroup);
00233 
00234 private:
00235     int mNbThresholds;
00236     KFbxProperty mThresholds;   
00237     bool Threshold(int pEl, fbxDistance pThreshValue, bool pCreateNew);
00238 
00239     int mNbDisplayLevels;
00240     KFbxProperty mDisplayLevels;
00241     bool DisplayLevel(int pEl, KFbxLodGroup::EDisplayLevel pValue, bool pCreateNew);
00242 
00243 public:
00244     virtual KString     GetTypeName() const;
00245     virtual KStringList GetTypeFlags() const;
00246 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00247 };
00248 
00249 typedef KFbxLodGroup* HKFbxLodGroup;
00250 inline EFbxType FbxTypeOf( KFbxLodGroup::EDisplayLevel const &pItem )           { return eENUM; }
00251 
00252 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00253 
00254 #endif // FBXFILESDK_KFBXPLUGINS_KFBXLODGROUP_H
00255