fbobjectpose.h File Reference

Contains definitions for object poses. More...

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

Go to the source code of this file.

Classes
class	FBObjectPoseOptions
	FBObjectPoseOptions class. More...
class	FBObjectPoseMirrorOptions
	FBObjectPoseMirrorOptions class. More...
class	FBObjectPose
	FBObjectPose class. More...
class	FBPropertyListObjectPose
	PropertyList: ObjectPose. More...

Macros
#define	FBSDK_DLL   K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once... More...

Enumerations
enum	FBPoseTransformType {   kFBPoseTransformInvalid = -1,   kFBPoseTransformLocal = 0,   kFBPoseTransformGlobal,   kFBPoseTransformLocalRef,   kFBPoseTransformTypeCount }
	Transform mode of pose. More...
enum	FBObjectPoseOptionsFlag {   kFBObjectPoseOptionsNoFlag = 0,   kFBObjectPoseOptionsTranslationX = 1,   kFBObjectPoseOptionsTranslationY = 1<<1,   kFBObjectPoseOptionsTranslationZ = 1<<2,   kFBObjectPoseOptionsRotation = 1<<3,   kFBObjectPoseOptionsScaling = 1<<4 }
	ObjectPoseOptions flags. More...
enum	FBObjectPoseMirrorOptionsFlag {   kFBObjectPoseMirrorOptionsNoFlag = 0,   kFBObjectPoseMirrorOptionsUpdateLocal = 1,   kFBObjectPoseMirrorOptionsUpdateLocalMirrorParent = 1<<1,   kFBObjectPoseMirrorOptionsUpdateLocalRef = 1<<2,   kFBObjectPoseMirrorOptionsUpdateLocalRefMirrorRef = 1<<3 }
	ObjectPoseMirrorOptions flags. More...

Functions
	FB_FORWARD (FBObjectPoseOptions)
	FB_FORWARD (FBObjectPoseMirrorOptions)
	__FB_FORWARD (FBObjectPose)
K_DLLIMPORT void	GetPlaneEquation (FBVector4< double > &pPlaneEquation, const FBTVector &pPlaneNormalVector, const FBTVector &pPointOnPlane)
	Get a plane equation from a normal vector and a point on the plane. More...
K_DLLIMPORT void	GetPlaneEquation (FBVector4< double > &pPlaneEquation, const FBTVector &pPointOnPlane, const FBMatrix &pPlaneRM)
	Get a plane equation from a point on the plane and a rotation matrix relative to the plane XZ. More...
K_DLLIMPORT void	GetPlaneRotation (FBMatrix &pPlaneRM, const FBVector4< double > &pPlaneEquation)
	Get the plane rotation matrix from a plane equation. More...
K_DLLIMPORT void	NormalizePlaneEquation (FBVector4< double > &pNormalizedPlaneEquation, FBVector4< double > &pPlaneEquation)
	Normalize a plane equation. More...
K_DLLIMPORT void	MirrorTransform (FBTVector &pMirrorT, FBMatrix &pMirrorRM, FBMatrix &pMirrorSM, const FBTVector &pT, const FBMatrix &pRM, const FBMatrix &pSM, const FBVector4< double > &pPlaneEquation)
	Mirror a transformation using the specified mirror plane. More...
K_DLLIMPORT void	MirrorTransformT (FBTVector &pMirrorT, const FBTVector &pT, const FBVector4< double > &pPlaneEquation)
	Mirror a translation using the specified mirror plane. More...
K_DLLIMPORT void	MirrorTransformR (FBMatrix &pMirrorRM, const FBMatrix &pRM, const FBVector4< double > &pPlaneEquation)
	Mirror a rotation using the specified mirror plane. More...

Detailed Description

Contains definitions for object poses.

Definition in file fbobjectpose.h.

Macro Definition Documentation

FBSDK_DLL

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbobjectpose.h.

Enumeration Type Documentation

FBObjectPoseMirrorOptionsFlag

enum FBObjectPoseMirrorOptionsFlag

ObjectPoseMirrorOptions flags.

Definition at line 81 of file fbobjectpose.h.

FBObjectPoseOptionsFlag

enum FBObjectPoseOptionsFlag

ObjectPoseOptions flags.

Definition at line 70 of file fbobjectpose.h.

FBPoseTransformType

enum FBPoseTransformType

Transform mode of pose.

Definition at line 60 of file fbobjectpose.h.

Function Documentation

GetPlaneEquation() [1/2]

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

Get a plane equation from a normal vector and a point on the plane.

Parameters

pPlaneEquation	Out: The plane equation computed.
pPlaneNormalVector	Normal vector to the plane.
pPointOnPlane	A point on the plane.

GetPlaneEquation() [2/2]

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

Get a plane equation from a point on the plane and a rotation matrix relative to the plane XZ.

Parameters

pPlaneEquation	Out: The plane equation computed.
pPointOnPlane	A point on the plane.
pPlaneRM	Rotation matrix of the plane, identity being the plane XZ.

GetPlaneRotation()

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

Get the plane rotation matrix from a plane equation.

Parameters

pPlaneRM	Out: Rotation matrix of the plane, identity being the plane XZ.
pPlaneEquation	The equation of the plane.

MirrorTransform()

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

Mirror a transformation using the specified mirror plane.

Parameters

pMirrorT	Out: Mirrored translation.
pMirrorRM	Out: Mirrored rotation.
pMirrorSM	Out: Mirrored scaling.
pT	Translation to mirror.
pRM	Rotation to mirror.
pSM	Scaling to mirror.
pPlaneEquation	The equation of the mirror plane.

MirrorTransformR()

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

Mirror a rotation using the specified mirror plane.

Parameters

pMirrorRM	Out: Mirrored rotation.
pRM	Rotation to mirror.
pPlaneEquation	The equation of the mirror plane.

MirrorTransformT()

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

Mirror a translation using the specified mirror plane.

Parameters

pMirrorT	Out: Mirrored translation.
pT	Translation to mirror.
pPlaneEquation	The equation of the mirror plane.

NormalizePlaneEquation()

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

Normalize a plane equation.

Parameters

pNormalizedPlaneEquation	Out: Plane equation normalized.
pPlaneEquation	Plane equation to normalized.