FormIt::Cameras API

Description

Functions
FORMIT_CORE_EXPORT WSM::Utils::CameraData	FormIt::Cameras::GetCameraData ()
	GetCameraData() function.
FORMIT_CORE_EXPORT WSM::Point3d	FormIt::Cameras::GetCameraWorldPosition ()
	GetCameraWorldPosition() function.
FORMIT_CORE_EXPORT WSM::Vector3d	FormIt::Cameras::GetCameraWorldForward ()
	GetCameraWorldForward() function.
FORMIT_CORE_EXPORT WSM::Vector3d	FormIt::Cameras::GetCameraWorldUp ()
	GetCameraWorldUp() function.
FORMIT_CORE_EXPORT bool	FormIt::Cameras::SetCameraData (WSM::Utils::CameraData &)
	SetCameraData() function.
FORMIT_CORE_EXPORT bool	FormIt::Cameras::SetCameraData (WSM::CameraData &)
FORMIT_CORE_EXPORT bool	FormIt::Cameras::AlignWithFace (const WSM::GroupInstancePath &facePath, bool withTransition)
	AlignWithFace() function.
FORMIT_CORE_EXPORT WSM::Utils::CameraProjectionType	FormIt::Cameras::GetProjectionType ()
	GetProjectionType() function.
FORMIT_CORE_EXPORT void	FormIt::Cameras::SetProjectionType (WSM::Utils::CameraProjectionType type)
	SetProjectionType() function.
FORMIT_CORE_EXPORT void	FormIt::Cameras::SetViewportSize (int width, int height)
	SetViewportSize() function.
FORMIT_CORE_EXPORT void	FormIt::Cameras::GetViewportSize (double &width, double &height)
	GetViewportSize() function.
FORMIT_CORE_EXPORT bool	FormIt::Cameras::SetPositionAndOrientation (const WSM::Point3d &aEye, const WSM::Point3d &aLook, const WSM::Vector3d &aUp)
	SetPositionAndOrientation() function.
FORMIT_CORE_EXPORT void	FormIt::Cameras::SetWorldForward (const WSM::Vector3d &forward)
	SetWorldForward() function.
FORMIT_CORE_EXPORT void	FormIt::Cameras::SetFieldOfView (double fieldOfView)
	SetFieldOfView() function.
FORMIT_CORE_EXPORT void	FormIt::Cameras::Transition3DTo2DTopOrtho (double duration)
	Transition3DTo2DTopOrtho() function.
FORMIT_CORE_EXPORT bool	FormIt::Cameras::Transition2DTopTo3DPersp (double altitudeAngle, double duration)
	Transition2DTopTo3DPersp() function.
FORMIT_CORE_EXPORT void	FormIt::Cameras::GetNearFar (float &Near, float &Far)
	Return the near and far clipping distances.
FORMIT_CORE_EXPORT bool	FormIt::Cameras::GetVerticalAngleLock ()
	GetVerticalAngleLock() function.
FORMIT_CORE_EXPORT void	FormIt::Cameras::SetVerticalAngleLock (bool bLock)
	SetVerticalAngleLock() function.

Function Documentation

AlignWithFace()

FORMIT_CORE_EXPORT bool FormIt::Cameras::AlignWithFace	(	const WSM::GroupInstancePath &	facePath,
		bool	withTransition
	)

AlignWithFace() function.

Parameters

[in]	facePath
[in]	withTransition

GetCameraData()

FORMIT_CORE_EXPORT WSM::Utils::CameraData FormIt::Cameras::GetCameraData

(

)

GetCameraData() function.

GetCameraWorldForward()

FORMIT_CORE_EXPORT WSM::Vector3d FormIt::Cameras::GetCameraWorldForward

(

)

GetCameraWorldForward() function.

GetCameraWorldPosition()

FORMIT_CORE_EXPORT WSM::Point3d FormIt::Cameras::GetCameraWorldPosition

(

)

GetCameraWorldPosition() function.

GetCameraWorldUp()

FORMIT_CORE_EXPORT WSM::Vector3d FormIt::Cameras::GetCameraWorldUp

(

)

GetCameraWorldUp() function.

GetNearFar()

FORMIT_CORE_EXPORT void FormIt::Cameras::GetNearFar	(	float &	Near,
		float &	Far
	)

Return the near and far clipping distances.

Parameters

[out]	Near
[out]	Far

GetProjectionType()

FORMIT_CORE_EXPORT WSM::Utils::CameraProjectionType FormIt::Cameras::GetProjectionType

(

)

GetProjectionType() function.

GetVerticalAngleLock()

FORMIT_CORE_EXPORT bool FormIt::Cameras::GetVerticalAngleLock

(

)

GetVerticalAngleLock() function.

GetViewportSize()

FORMIT_CORE_EXPORT void FormIt::Cameras::GetViewportSize	(	double &	width,
		double &	height
	)

GetViewportSize() function.

Parameters

[out]	width
[out]	height

SetCameraData() [1/2]

FORMIT_CORE_EXPORT bool FormIt::Cameras::SetCameraData

(

WSM::CameraData &

)

SetCameraData() [2/2]

FORMIT_CORE_EXPORT bool FormIt::Cameras::SetCameraData

(

WSM::Utils::CameraData &

)

SetCameraData() function.

SetFieldOfView()

FORMIT_CORE_EXPORT void FormIt::Cameras::SetFieldOfView

(

double

fieldOfView

)

SetFieldOfView() function.

Parameters

[in]

fieldOfView

SetPositionAndOrientation()

FORMIT_CORE_EXPORT bool FormIt::Cameras::SetPositionAndOrientation	(	const WSM::Point3d &	aEye,
		const WSM::Point3d &	aLook,
		const WSM::Vector3d &	aUp
	)

SetPositionAndOrientation() function.

Parameters

[in]	aEye
[in]	aLook
[in]	aUp

SetProjectionType()

FORMIT_CORE_EXPORT void FormIt::Cameras::SetProjectionType

(

WSM::Utils::CameraProjectionType

type

)

SetProjectionType() function.

Parameters

[in]

type

SetVerticalAngleLock()

FORMIT_CORE_EXPORT void FormIt::Cameras::SetVerticalAngleLock

(

bool

bLock

)

SetVerticalAngleLock() function.

Parameters

[in]

bLock

SetViewportSize()

FORMIT_CORE_EXPORT void FormIt::Cameras::SetViewportSize	(	int	width,
		int	height
	)

SetViewportSize() function.

Parameters

[in]	width
[in]	height

SetWorldForward()

FORMIT_CORE_EXPORT void FormIt::Cameras::SetWorldForward

(

const WSM::Vector3d &

forward

)

SetWorldForward() function.

Parameters

[in]

forward

Transition2DTopTo3DPersp()

FORMIT_CORE_EXPORT bool FormIt::Cameras::Transition2DTopTo3DPersp	(	double	altitudeAngle,
		double	duration
	)

Transition2DTopTo3DPersp() function.

Parameters

[in]	altitudeAngle
[in]	duration

Transition3DTo2DTopOrtho()

FORMIT_CORE_EXPORT void FormIt::Cameras::Transition3DTo2DTopOrtho

(

double

duration

)

Transition3DTo2DTopOrtho() function.

Parameters

[in]

duration