#include "beastapitypes.h"

File Description

The beast camera function definitions.

Enumerations
enum	ILBEnvironmentCameraType { ILB_ECT_CUBEMAP = 0, ILB_ECT_BALL, ILB_ECT_LATLONG }

Functions
ILBStatus	ILBCreateEnvironmentCamera (ILBSceneHandle scene, ILBConstString name, const ILBMatrix4x4 transform, ILBEnvironmentCameraType type, ILBCameraHandle camera)

ILBStatus	ILBCreatePerspectiveCamera (ILBSceneHandle scene, ILBConstString name, const ILBMatrix4x4 transform, ILBCameraHandle camera)

ILBStatus	ILBGetCameraFov (ILBCameraHandle camera, float horizontalFovRadians, float pixelAspectRatio)

ILBStatus	ILBGetCameraName (ILBCameraHandle camera, ILBStringHandle *name)

ILBStatus	ILBGetCameraTransform (ILBCameraHandle camera, ILBMatrix4x4 *transform)

ILBStatus	ILBSetCameraDisplayName (ILBCameraHandle camera, ILBConstString displayName)

ILBStatus	ILBSetCameraDof (ILBCameraHandle camera, float fstop, float focusDistance, int32 blades)

ILBStatus	ILBSetCameraMotionTransforms (ILBCameraHandle camera, const ILBMatrix4x4 *transforms, int32 count)

ILBStatus	ILBSetCameraTransform (ILBCameraHandle camera, const ILBMatrix4x4 *transform)

ILBStatus	ILBSetFov (ILBCameraHandle camera, float horizontalFovRadians, float pixelAspectRatio)

ILBStatus	ILBSetVerticalFov (ILBCameraHandle camera, float verticalFovRadians)

Enumeration Type Documentation

enum ILBEnvironmentCameraType

Environment camera types.

Enumerator
ILB_ECT_CUBEMAP	Cubemap environment camera.
ILB_ECT_BALL	Ball environment camera.
ILB_ECT_LATLONG	Latlong environment camera.

Function Documentation

ILBStatus ILBCreateEnvironmentCamera	(	ILBSceneHandle	scene,
		ILBConstString	name,
		const ILBMatrix4x4 *	transform,
		ILBEnvironmentCameraType	type,
		ILBCameraHandle *	camera
	)

Add an environment camera to the scene.

Parameters

scene	the scene the camera should be a part of
name	the name of the camera, must be unique within the scene.
transform	the object space to world space transform for this camera
type	the type of environment camera, i.e Ball, Cubemap or Latlong
camera	the handle to store the generated camera in

Returns: The result of the operation.

ILBStatus ILBCreatePerspectiveCamera	(	ILBSceneHandle	scene,
		ILBConstString	name,
		const ILBMatrix4x4 *	transform,
		ILBCameraHandle *	camera
	)

Add a camera to the scene.

The camera looks in the negative z direction, positive x in camera space maps to right in screen space. positive y maps to up i screen space.

Parameters

scene	the scene the camera should be a part of
name	the name of the camera, must be unique within the scene.
transform	the object space to world space transform for this camera
camera	the handle to store the generated camera in

Returns: The result of the operation.

Examples:: examples-physical/code/common/samplescommon.h, examples/code/atlas/atlas.cpp, examples/code/baking/baking.cpp, examples/code/cache/cache.cpp, examples/code/ernst/ernst.cpp, examples/code/lightsources/lightsources.cpp, examples/code/liveernst/liveernst.cpp, examples/code/lua/lua.cpp, examples/code/materials/materials.cpp, examples/code/occlusion/occlusion.cpp, examples/code/pointcloud/pointcloud.cpp, examples/code/readback/readback.cpp, examples/code/renderstats/renderstats.cpp, examples/code/rnm/rnm.cpp, examples/code/shbaking/shbaking.cpp, examples/code/simple/simple.cpp, and examples/code/uvset/uvset.cpp.

ILBStatus ILBGetCameraFov	(	ILBCameraHandle	camera,
		float *	horizontalFovRadians,
		float *	pixelAspectRatio
	)

Gets the fov of the camera.

Only works on perspective cameras. The vertical fov will be generated from the horizontal fov and the image dimensions

Parameters

camera	the camera to get fov for
horizontalFovRadians	the field of view in the X direction in radians. Note that it refers to the complete field of vision, not the angle to the forward direction.
pixelAspectRatio	the aspect ratio of a pixel, expressed as the x / y

Examples:: examples/code/ernst/ernst.cpp.

ILBStatus ILBGetCameraName	(	ILBCameraHandle	camera,
		ILBStringHandle *	name
	)

Gets the name of a camera.

This is used for cameras returned from an Ernst session.

Parameters

camera	the camera to get the name for
name	the returned camera name

Examples:: examples/code/ernst/ernst.cpp.

ILBStatus ILBGetCameraTransform	(	ILBCameraHandle	camera,
		ILBMatrix4x4 *	transform
	)

Gets the transform of a camera.

This is used for cameras returned from an Ernst session.

Parameters

camera	the camera to get the transform for
transform	the returned camera transform

Returns: The result of the operation.

Examples:: examples/code/ernst/ernst.cpp.

ILBStatus ILBSetCameraDisplayName	(	ILBCameraHandle	camera,
		ILBConstString	displayName
	)

Sets the display name for the camera.

This name does not have to be unique within the scene and can be used by tools to give human understandable names to objects that has names that are generated and for some reason isn't suitable to read

Parameters

camera	the camera to set the name for
displayName	the display name to set

ILBStatus ILBSetCameraDof	(	ILBCameraHandle	camera,
		float	fstop,
		float	focusDistance,
		int32	blades
	)

Sets depth of field parameters for the camera.

Parameters

camera	the camera to set depth of field on
fstop	the aperture fstop
focusDistance	distance from camera to focal plane
blades	The number of shutter blades used to construct a non-circular dof a value less than 3 will produce a circular dof

ILBStatus ILBSetCameraMotionTransforms	(	ILBCameraHandle	camera,
		const ILBMatrix4x4 *	transforms,
		int32	count
	)

Sets the motion transforms of a motion blurred camera.

Parameters

camera	the camera to set the transform for
transforms	an array of transforms describing the camera motion
count	the number of transforms in the array

Returns: The result of the operation.

ILBStatus ILBSetCameraTransform	(	ILBCameraHandle	camera,
		const ILBMatrix4x4 *	transform
	)

Sets the transform of a camera.

Parameters

camera	the camera to set the transform for
transform	the new camera transform

Returns: The result of the operation.

Examples:: examples-physical/code/materials-live/materials-live.cpp.

ILBStatus ILBSetFov	(	ILBCameraHandle	camera,
		float	horizontalFovRadians,
		float	pixelAspectRatio
	)

Sets the fov of the camera.

Only works on perspective cameras. The vertical fov will be generated from the horizontal fov and the image dimensions

Parameters

camera	the camera to set fov for
horizontalFovRadians	the field of view in the X direction in radians. Note that it refers to the complete field of vision, not the angle to the forward direction. Negative horizontalFovRadians is currently not supported
pixelAspectRatio	the aspect ratio of a pixel, expressed as the x / y

Examples:: examples-physical/code/common/samplescommon.h, examples/code/ernst/ernst.cpp, examples/code/lightsources/lightsources.cpp, examples/code/liveernst/liveernst.cpp, examples/code/materials/materials.cpp, examples/code/simple/simple.cpp, and examples/code/uvset/uvset.cpp.

ILBStatus ILBSetVerticalFov	(	ILBCameraHandle	camera,
		float	verticalFovRadians
	)

Sets the vertical fov of the camera.

Only works on perspective cameras in scenes locked for use in a Live Ernst Job.

Parameters

camera	the camera to set vertical fov for
verticalFovRadians	the field of view in the Y direction in radians. Note that it refers to the complete field of vision, not the angle to the forward direction. Negative horizontalFovRadians is not supported

Go to the source code of this file.

beastapi/beastcamera.h File Reference

File Description

Enumerations

Functions

Enumeration Type Documentation

Function Documentation