fbobjectpose.h

Go to the documentation of this file.

#ifndef __FBOBJECTPOSE_H__
#define __FBOBJECTPOSE_H__
/**************************************************************************
 Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.
 
 The coded instructions, statements, computer programs, and/or related 
 material (collectively the "Data") in these files contain unpublished 
 information proprietary to Autodesk, Inc. and/or its licensors, which is 
 protected by Canada and United States of America federal copyright law 
 and by international treaties.
 
 The Data may not be disclosed or distributed to third parties, in whole 
 or in part, without the prior written consent of Autodesk, Inc. 
 ("Autodesk").
 
 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
 ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
 OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
 PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
 WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
 FREE.
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
 EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
 DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
 OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
 DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
 LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
 LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
 DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
 BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
 
**************************************************************************/

#include <kaydaradef.h>
#ifndef FBSDK_DLL 

    #define FBSDK_DLL K_DLLIMPORT
#endif

#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbpose.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif


enum FBPoseTransformType
{ 
    kFBPoseTransformInvalid = -1, 
    kFBPoseTransformLocal   =  0,
    kFBPoseTransformGlobal, 
    kFBPoseTransformLocalRef, 
    kFBPoseTransformTypeCount
};

enum FBObjectPoseOptionsFlag
{
    kFBObjectPoseOptionsNoFlag      = 0,
    kFBObjectPoseOptionsTranslationX= 1,
    kFBObjectPoseOptionsTranslationY= 1<<1,
    kFBObjectPoseOptionsTranslationZ= 1<<2,
    kFBObjectPoseOptionsRotation    = 1<<3,
    kFBObjectPoseOptionsScaling     = 1<<4,
};

enum FBObjectPoseMirrorOptionsFlag
{
    kFBObjectPoseMirrorOptionsNoFlag                    = 0,
    kFBObjectPoseMirrorOptionsUpdateLocal               = 1,
    kFBObjectPoseMirrorOptionsUpdateLocalMirrorParent   = 1<<1,
    kFBObjectPoseMirrorOptionsUpdateLocalRef            = 1<<2,
    kFBObjectPoseMirrorOptionsUpdateLocalRefMirrorRef   = 1<<3,
};

// FBObjectPoseOptions
FB_FORWARD( FBObjectPoseOptions );

class FBSDK_DLL FBObjectPoseOptions
{
  public:

    FBPoseTransformType mPoseTransformType;

    FBTVector mReferenceGT;

    FBMatrix mReferenceGRM;

    FBMatrix mReferenceGSM;

    FBObjectPoseOptions();

    void SetFlag( FBObjectPoseOptionsFlag pFlag, bool pValue );

    bool GetFlag( FBObjectPoseOptionsFlag pFlag );

    void ClearFlag();

  private:

    FBObjectPoseOptionsFlag mFlags;
};

// FBObjectPoseMirrorOptions
FB_FORWARD( FBObjectPoseMirrorOptions );

class FBSDK_DLL FBObjectPoseMirrorOptions
{
  public:

    FBVector4<double> mMirrorPlaneEquation;

    FBObjectPoseMirrorOptions();

    void SetFlag( FBObjectPoseMirrorOptionsFlag pFlag, bool pValue );

    bool GetFlag( FBObjectPoseMirrorOptionsFlag pFlag );

    void ClearFlag();

  private:

    FBObjectPoseMirrorOptionsFlag mFlags;
};

// FBObjectPose
__FB_FORWARD( FBObjectPose );

class FBSDK_DLL FBObjectPose : public FBPose
{
    //--- Open Reality declaration.
    __FBClassDeclare( FBObjectPose, FBPose );

  public:
    FBObjectPose( const char* pName, HIObject pObject=NULL );

    void ClearPose();

    bool IsPropertyPoseable( FBProperty &pProperty );

    FBStringList GetStoredObjectNames();

    void CopyObjectPose( const char* pObjectName, FBComponent& pObject );

    void CopyPropertyPose( const char* pObjectName, FBProperty& pProperty );

    void PasteObjectPose( const char* pObjectName, FBComponent& pObject );

    void PastePropertyPose( const char* pObjectName, FBProperty& pProperty );

    void SetPropertyValue( const char* pObjectName, const char* pPropertyName, double* pValue, int pSize );

    void GetPropertyValue( double* pValue, int pSize, const char* pObjectName, const char* pPropertyName );

    bool IsPropertyStored( const char* pObjectName, const char* pPropertyName );

    void CopyTransform( const char* pObjectName, FBComponent& pObject, FBObjectPoseOptions& pObjectPoseOptions );

    void PasteTransform( const char* pObjectName, FBComponent& pObject, FBObjectPoseOptions& pObjectPoseOptions, FBEvaluateInfo* pEvaluateInfo = NULL  );

    void SetTransform( FBTVector& pT, FBMatrix& pRM, FBMatrix& pSM, const char* pObjectName, FBPoseTransformType pPoseTransformType );

    bool GetTransform( FBTVector& pT, FBMatrix& pRM, FBMatrix& pSM, const char* pObjectName, FBPoseTransformType pPoseTransformType );

    bool IsTransformStored( const char* pObjectName, FBPoseTransformType pPoseTransformType = kFBPoseTransformInvalid );

    void MultTransformAllObjects( FBMatrix& pGX, FBModelTransformationType pTransformAttribute, FBPoseTransformType pPoseTransformType );

    void MultTransform( const char* pObjectName, FBMatrix& pGX, FBModelTransformationType pTransformAttribute, FBPoseTransformType pPoseTransformType );

    void MirrorPoseAllObjects( FBObjectPoseMirrorOptions& pObjectPoseMirrorOptions );

    void MirrorPose( const char* pObjectName, FBObjectPoseMirrorOptions& pObjectPoseMirrorOptions );

    void RemoveStanceOffsetAllObjects( FBObjectPose& pStancePose, FBPoseTransformType pPoseTransformType = kFBPoseTransformInvalid );
    
    void RemoveStanceOffset( const char* pObjectName, FBObjectPose& pStancePose, FBPoseTransformType pPoseTransformType = kFBPoseTransformInvalid );
    
    void AddStanceOffsetAllObjects( FBObjectPose& pStancePose, FBPoseTransformType pPoseTransformType = kFBPoseTransformInvalid );
    
    void AddStanceOffset( const char* pObjectName, FBObjectPose& pStancePose, FBPoseTransformType pPoseTransformType = kFBPoseTransformInvalid );

    static void MirrorRetargetPoseAllObjects
    (
        FBObjectPose& pDstPose,
        FBObjectPose& pSrcPose,
        FBObjectPose& pDstStancePose,
        FBObjectPose& pSrcStancePose,
        FBVector4<double>& pMirrorPlaneEquation
    );

    static void MirrorRetargetPose
    (
        FBObjectPose& pDstPose,
        FBObjectPose& pSrcPose,
        FBObjectPose& pDstStancePose,
        FBObjectPose& pSrcStancePose,
        FBVector4<double>& pMirrorPlaneEquation,
        const char* pDstObjectName,
        const char* pSrcObjectName
    );

    static void RetargetPose
    (
        FBObjectPose& pDstPose,
        FBObjectPose& pSrcPose,
        const char* pDstObjectName,
        const char* pSrcObjectName
    );

    void CopyFrom( FBObjectPose& pFromPose );

    void CopyPoseDataFrom( FBObjectPose& pFromPose );

    void CopyPoseAllObjectsTransformFrom( FBObjectPose& pFromPose, FBPoseTransformType pPoseTransformType = kFBPoseTransformInvalid );

    void CopyPoseTransformFrom( FBObjectPose& pFromPose, const char* pObjectName, FBPoseTransformType pPoseTransformType = kFBPoseTransformInvalid );

  private:


    FBObjectPose( const FBObjectPose& );
    FBObjectPose& operator=( const FBObjectPose& );
};

// Property List: ObjectPose

class FBSDK_DLL FBPropertyListObjectPose : public FBPropertyListComponent
{
  public:
    FBPropertyListObjectPose();
    FBObjectPose* operator[]( int pIndex );
};

// Useful functions

FBSDK_DLL void GetPlaneEquation( FBVector4<double>& pPlaneEquation, const FBTVector& pPlaneNormalVector, const FBTVector& pPointOnPlane );

FBSDK_DLL void GetPlaneEquation( FBVector4<double>& pPlaneEquation, const FBTVector& pPointOnPlane, const FBMatrix& pPlaneRM );

FBSDK_DLL void GetPlaneRotation( FBMatrix& pPlaneRM, const FBVector4<double>& pPlaneEquation );

FBSDK_DLL void NormalizePlaneEquation( FBVector4<double>& pNormalizedPlaneEquation, FBVector4<double>& pPlaneEquation );

FBSDK_DLL void MirrorTransform( FBTVector& pMirrorT, FBMatrix& pMirrorRM, FBMatrix& pMirrorSM, const FBTVector& pT, const FBMatrix& pRM, const FBMatrix& pSM, const FBVector4<double>& pPlaneEquation );

FBSDK_DLL void MirrorTransformT( FBTVector& pMirrorT, const FBTVector& pT, const FBVector4<double>& pPlaneEquation );

FBSDK_DLL void MirrorTransformR( FBMatrix& pMirrorRM, const FBMatrix& pRM, const FBVector4<double>& pPlaneEquation );


#ifdef FBSDKUseNamespace
    }
#endif

#endif /* __FBOBJECTPOSE_H__ */