FBX SDK Reference Guide: kfbxnodelimits.h Source File
Go to the documentation of this file.
00001 
00004 #ifndef _FBXSDK_NODE_LIMITS_H_
00005 #define _FBXSDK_NODE_LIMITS_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 <kfbxmath/kfbxvector4.h>
00050 
00051 #ifndef MB_FBXSDK
00052 #include <kbaselib_nsuse.h>
00053 #endif
00054 #include <kbaselib_forward.h>
00055 
00056 #include <fbxfilesdk_nsbegin.h>
00057 
00058 class KFbxNode;
00059 
00065 typedef enum 
00066     {
00067         eTRANSLATION,          
00068         eROTATION,            
00069         eSCALE,     
00070     } ELimitedProperty;
00071 
00078 class KFBX_DLL KFbxLimits
00079 {
00080     public:
00082         KFbxLimits(KMBTransform *pMBTransform = NULL);      
00083 
00085         virtual ~KFbxLimits();
00086         
00087 
00093         void SetLimitMinActive(const bool pXActive, const bool pYActive, const bool pZActive);
00094 
00100         void GetLimitMinActive(bool& pXActive, bool& pYActive, bool& pZActive) const;
00101 
00107         void SetLimitMaxActive(const bool pXActive, const bool pYActive, const bool pZActive);
00108 
00114         void GetLimitMaxActive(bool& pXActive, bool& pYActive, bool& pZActive) const;
00115 
00119         bool GetLimitSomethingActive() const;
00120         
00124         void        SetLimitMin(const KFbxVector4& pMin);
00125 
00129         KFbxVector4 GetLimitMin() const;
00130 
00134         void        SetLimitMax(const KFbxVector4& pMax);
00135 
00139         KFbxVector4 GetLimitMax() const;
00140         
00144         inline void SetLimitedProperty(ELimitedProperty pProperty)
00145         {
00146             mProperty = pProperty;
00147         }
00148 
00152         inline ELimitedProperty  GetLimitedProperty()
00153         {
00154             return mProperty;
00155         }
00156 
00157         KFbxLimits& operator = (const KFbxLimits& pFbxLimit);
00158 
00159 
00160     private:    
00161         bool mNeedsMBTransformDelete;
00162         KMBTransform*       mMBTransform;
00163         ELimitedProperty mProperty;
00164 };
00165 
00169 class KFBX_DLL KFbxNodeLimits
00170 {
00171     
00172     public:
00177         KFbxNodeLimits(KFbxNode *pLimitedNode,KMBTransform *pMBTransform);
00178 
00183         KFbxNode* GetLimitedNode();
00184 
00189 
00194         void SetTranslationLimitActive(bool pActive);
00195 
00200         bool GetTranslationLimitActive();
00201 
00203         KFbxLimits mTranslationLimits;
00204 
00206 
00211 
00216         void SetRotationLimitActive(bool pActive);
00217 
00222         bool GetRotationLimitActive();
00223 
00225         KFbxLimits mRotationLimits;
00226 
00228 
00233 
00238         void SetScalingLimitActive(bool pActive);
00239 
00244         bool GetScalingLimitActive();
00245 
00247         KFbxLimits mScalingLimits;
00248 
00250 
00251 #ifndef DOXYGEN_SHOULD_SKIP_THIS    
00252 
00253         KFbxNodeLimits& operator=(KFbxNodeLimits const& pNodeLimits); 
00254 
00255     private:
00257         KFbxNode*             mLimitedNode;
00258         KMBTransform *        mMBTransform;
00259     friend class KFbxNode;
00260 #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS
00261 };
00262 
00263 typedef KFbxLimits* HKFbxLimits;
00264 
00265 #include <fbxfilesdk_nsend.h>
00266 
00267 #endif // #ifndef _FBXSDK_NODE_LIMITS_H_
00268 
00269