FBX SDK Reference Guide: kfbxnodelimits.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef FBXFILESDK_KFBXPLUGINS_KFBXNODELIMITS_H
00005 #define FBXFILESDK_KFBXPLUGINS_KFBXNODELIMITS_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/kfbxmath/kfbxvector4.h>
00046 
00047 #include <fbxfilesdk/components/kbaselib/kbaselib_forward.h>
00048 
00049 #include <fbxfilesdk/fbxfilesdk_nsbegin.h>
00050 
00051 class KFbxNode;
00052 
00058 typedef enum 
00059     {
00060         eTRANSLATION,          
00061         eROTATION,            
00062         eSCALE,     
00063     } ELimitedProperty;
00064 
00071 class KFBX_DLL KFbxLimits
00072 {
00073     public:
00077         KFbxLimits(KMBTransform *pMBTransform = NULL);      
00078 
00080         virtual ~KFbxLimits();
00081         
00082 
00088         void SetLimitMinActive(const bool pXActive, const bool pYActive, const bool pZActive);
00089 
00095         void GetLimitMinActive(bool& pXActive, bool& pYActive, bool& pZActive) const;
00096 
00102         void SetLimitMaxActive(const bool pXActive, const bool pYActive, const bool pZActive);
00103 
00109         void GetLimitMaxActive(bool& pXActive, bool& pYActive, bool& pZActive) const;
00110 
00114         bool GetLimitSomethingActive() const;
00115         
00119         void        SetLimitMin(const KFbxVector4& pMin);
00120 
00124         KFbxVector4 GetLimitMin() const;
00125 
00129         void        SetLimitMax(const KFbxVector4& pMax);
00130 
00134         KFbxVector4 GetLimitMax() const;
00135         
00139         inline void SetLimitedProperty(ELimitedProperty pProperty)
00140         {
00141             mProperty = pProperty;
00142         }
00143 
00147         inline ELimitedProperty  GetLimitedProperty()
00148         {
00149             return mProperty;
00150         }
00151         
00155         KFbxLimits& operator = (const KFbxLimits& pFbxLimit);
00156 
00157 
00158     private:    
00159         bool mNeedsMBTransformDelete;
00160         KMBTransform*       mMBTransform;
00161         ELimitedProperty mProperty;
00162 };
00163 
00167 class KFBX_DLL KFbxNodeLimits
00168 {
00169     
00170     public:
00175         KFbxNodeLimits(KFbxNode *pLimitedNode,KMBTransform *pMBTransform);
00176 
00181         KFbxNode* GetLimitedNode();
00182 
00187 
00192         void SetTranslationLimitActive(bool pActive);
00193 
00198         bool GetTranslationLimitActive();
00199 
00201         KFbxLimits mTranslationLimits;
00202 
00204 
00209 
00214         void SetRotationLimitActive(bool pActive);
00215 
00220         bool GetRotationLimitActive();
00221 
00223         KFbxLimits mRotationLimits;
00224 
00226 
00231 
00236         void SetScalingLimitActive(bool pActive);
00237 
00242         bool GetScalingLimitActive();
00243 
00245         KFbxLimits mScalingLimits;
00246 
00248 
00249 #ifndef DOXYGEN_SHOULD_SKIP_THIS    
00250 
00251         KFbxNodeLimits& operator=(KFbxNodeLimits const& pNodeLimits); 
00252 
00253     private:
00255         KFbxNode*             mLimitedNode;
00256         KMBTransform *        mMBTransform;
00257     friend class KFbxNode;
00258 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00259 };
00260 
00261 typedef KFbxLimits* HKFbxLimits;
00262 
00263 #include <fbxfilesdk/fbxfilesdk_nsend.h>
00264 
00265 #endif // FBXFILESDK_KFBXPLUGINS_KFBXNODELIMITS_H
00266