fbcharacterpose.h

Go to the documentation of this file.

#ifndef __FBCHARACTERPOSE_H__
#define __FBCHARACTERPOSE_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

FB_FORWARD( FBCharacter );
FB_FORWARD( FBCharacterExtension );
FB_FORWARD( FBObjectPose );
FB_FORWARD( FBModel );

enum FBCharacterPoseFlag
{
    kFBCharacterPoseNoFlag              = 0,
    kFBCharacterPoseMirror              = 1,
    kFBCharacterPoseGravity             = 1<<1,
    kFBCharacterPoseMatchTX             = 1<<2,
    kFBCharacterPoseMatchTY             = 1<<3,
    kFBCharacterPoseMatchTZ             = 1<<4,
    kFBCharacterPoseMatchR              = 1<<5,
    kFBCharacterPoseMatchPivot          = 1<<6,
    kFBCharacterPoseUseKeyingGroup      = 1<<7,
    kFBCharacterPoseMatchFKTranslation  = 1<<8
};

enum FBMirrorPlaneType
{
    kFBMirrorPlaneTypeInvalid = -1,
    kFBMirrorPlaneTypeAuto    =  0,
    kFBMirrorPlaneTypeZY,
    kFBMirrorPlaneTypeXY,
    kFBMirrorPlaneTypeXZ,
    kFBMirrorPlaneTypeUser,
    kFBMirrorPlaneTypeEquation,
    kFBMirrorPlaneTypeCount
};

enum FBCharacterPoseKeyingMode
{
    kFBCharacterPoseKeyingModeInvalid   = -1,
    kFBCharacterPoseKeyingModeFullBody  =  0,
    kFBCharacterPoseKeyingModeBodyPart,
    kFBCharacterPoseKeyingModeCount
};

// FBCharacterPoseOptions
FB_FORWARD( FBCharacterPoseOptions );

class FBSDK_DLL FBCharacterPoseOptions
{
  public:

    FBModel* mModelToMatch;

    FBCharacterPoseKeyingMode mCharacterPoseKeyingMode;

    FBMirrorPlaneType mMirrorPlaneType;

    FBVector4<double> mMirrorPlaneEquation;

    double mMirrorPlaneTiltAngle;

    double mMirrorPlanePanAngle;
    
    FBCharacterPoseOptions();

    void SetFlag( FBCharacterPoseFlag pFlag, bool pValue );

    bool GetFlag( FBCharacterPoseFlag pFlag ) const;

    void ClearFlag();

  private:

    FBCharacterPoseFlag mFlags;
};

// FBCharacterPose
__FB_FORWARD( FBCharacterPose );

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

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

    void ClearPose();

    void ClearCharacterPose();

    void ClearCharacterExtensionsPose();

    void CopyPose( FBCharacter& pCharacter );

    void CopyPoseCharacter( FBCharacter& pCharacter );

    void CopyPoseCharacterExtensions( FBCharacter& pCharacter );

    void CopyPoseCharacterExtension( FBCharacterExtension& pCharacterExtension );

    void PastePose( FBCharacter& pCharacter, FBCharacterPoseOptions& pCharacterPoseOptions );

    void PastePoseCharacter( FBCharacter& pCharacter, FBCharacterPoseOptions& pCharacterPoseOptions );

    void PastePoseCharacterExtensions( FBCharacter& pCharacter, FBCharacterPoseOptions& pCharacterPoseOptions );

    void PastePoseCharacterExtension( FBCharacterExtension& pCharacterExtension, FBCharacterPoseOptions& pCharacterPoseOptions );

    bool IsCharacterPoseStored();

    bool IsCharacterExtensionPoseStored( const char* pCharacterExtensionName );

    void CopyFrom( FBCharacterPose& pFromPose );

    void CopyPoseDataFrom( FBCharacterPose& pFromPose );

    void CopyPoseCharacterFrom( FBCharacterPose& pFromPose );

    void CopyPoseCharacterExtensionsFrom( FBCharacterPose& pFromPose );

    int GetCharacterExtensionPoseCount();

    FBObjectPose* GetCharacterExtensionPoseAt( int pIndex );
    
    FBObjectPose* GetCharacterExtensionPose( const char* pCharacterExtensionName );

    FBObjectPose* GetOrCreateCharacterExtensionPose( const char* pCharacterExtensionName );

    void RemoveCharacterExtensionPoseAt( int pIndex );
    
    void RemoveCharacterExtensionPose( const char* pCharacterExtensionName );

    FBString GetCharacterExtensionNameFromPose( FBObjectPose& pCharacterExtensionPose );

    void GetMirrorPlaneEquation( FBVector4<double>& pMirrorPlaneEquation, FBCharacter& pCharacter, FBCharacterPoseOptions& pCharacterPoseOptions );

    void GetMirrorPlaneEquation( FBMatrix& pMirrorPlaneEquation, FBCharacter& pCharacter, FBCharacterPoseOptions& pCharacterPoseOptions );

    
    int GetExtraBoneCount();

    FBModel* GetExtraBoneModelAt(int pIndex);

    void GetExtraBoneTransformOffset(FBVector3d &pT, FBVector3d &pR, FBVector3d &pS, int pIndex );

    void GetExtraBoneTransform(FBVector3d &pT, FBVector3d &pR, FBVector3d &pS, int pIndex );

    void GetExtraBoneParentRotationOffset( FBRVector &pR, int pIndex );

    void ApplyPoseCandidate();

  private:


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

// Property List: CharacterPose

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

#ifdef FBSDKUseNamespace
    }
#endif

#endif /* __FBCHARACTERPOSE_H__ */