beastscene.h File Reference

#include "beastapitypes.h"

File Description

The api for specifying scenes in beast.

Enumerations
enum	ILBSceneUpVector {   ILB_UP_POS_X = 0, ILB_UP_NEG_X, ILB_UP_POS_Y, ILB_UP_NEG_Y,   ILB_UP_POS_Z, ILB_UP_NEG_Z }

Functions
ILBStatus	ILBBeginPhysicalScene (ILBManagerHandle beastManager, ILBConstString uniqueName, ILBSceneHandle *target)
ILBStatus	ILBBeginScene (ILBManagerHandle beastManager, ILBConstString uniqueName, ILBSceneHandle *target)
ILBStatus	ILBEndScene (ILBSceneHandle scene)
ILBStatus	ILBGetMeterPerWorldUnit (ILBSceneInfoHandle scene, float *meterPerWorldUnit)
ILBStatus	ILBGetSceneUpVector (ILBSceneInfoHandle scene, ILBSceneUpVector *upVector)
ILBStatus	ILBReleaseScene (ILBSceneHandle scene)
ILBStatus	ILBSetMeterPerWorldUnit (ILBSceneHandle scene, float meterPerWorldUnit)
ILBStatus	ILBSetSceneUpVector (ILBSceneHandle scene, ILBSceneUpVector upVector)

Enumeration Type Documentation

enum ILBSceneUpVector

The scene up vector.

Enumerator
ILB_UP_POS_X	Positive direction of the X axis.
ILB_UP_NEG_X	Negative direction of the X axis.
ILB_UP_POS_Y	Positive direction of the Y axis.
ILB_UP_NEG_Y	Negative direction of the Y axis.
ILB_UP_POS_Z	Positive direction of the Z axis.
ILB_UP_NEG_Z	Negative direction of the Z axis.

Function Documentation

ILBStatus ILBBeginPhysicalScene	(	ILBManagerHandle	beastManager,
		ILBConstString	uniqueName,
		ILBSceneHandle *	target
	)

Begins creation of a scene that will use physical materials set up with OSL shaders.

Parameters

beastManager	the beast manager this scene will be associated with
uniqueName	a unique name for the scene.
target	a pointer to a Beast scene object that will receive the created object

Returns

The result of the operation.

Examples:

ILBStatus ILBBeginScene	(	ILBManagerHandle	beastManager,
		ILBConstString	uniqueName,
		ILBSceneHandle *	target
	)

Begins creation of a scene that will use "classic" fixed-function materials.

Parameters

beastManager	the beast manager this scene will be associated with
uniqueName	a unique name for the scene.
target	a pointer to a Beast scene object that will receive the created object

Returns

The result of the operation.

Examples:

ILBStatus ILBEndScene

(

ILBSceneHandle

scene

)

Finalizes this scene Any future call to modify this scene or any of its objects will fail.

Parameters

scene

the scene to finalize

Returns

The result of the operation.

Examples:

ILBStatus ILBGetMeterPerWorldUnit	(	ILBSceneInfoHandle	scene,
		float *	meterPerWorldUnit
	)

Gets how many meters a world unit in represents for the scene.

This parameter is returned from an Ernst session in a SceneInfo node.

Parameters

scene	the current scene
meterPerWorldUnit	the relation between a meter and a world unit in the scene.

Returns

The result of the operation.

Examples:

ILBStatus ILBGetSceneUpVector	(	ILBSceneInfoHandle	scene,
		ILBSceneUpVector *	upVector
	)

Gets the up vector of the scene.

This parameter is returned from an Ernst session in a SceneInfo node.

Parameters

scene	the current scene
upVector	the direction of the up vector.

Returns

The result of the operation.

Examples:

ILBStatus ILBReleaseScene

(

ILBSceneHandle

scene

)

Releases the scene data.

All handles created in this scene will be invalid after this call.

Parameters

scene

the scene to to release.

Examples:

ILBStatus ILBSetMeterPerWorldUnit	(	ILBSceneHandle	scene,
		float	meterPerWorldUnit
	)

Sets how many meters a world unit in represents for the scene.

This parameter is optional. It is used by eRnsT optimize the user experience in the external editor.

Parameters

scene	the current scene
meterPerWorldUnit	the relation between a meter and a world unit in the scene.

Returns

The result of the operation.

Examples:

ILBStatus ILBSetSceneUpVector	(	ILBSceneHandle	scene,
		ILBSceneUpVector	upVector
	)

Sets the up vector of the scene.

This parameter is optional. It is used by eRnsT editor.

Parameters

scene	the current scene
upVector	the direction of the up vector.

Returns

The result of the operation.

Examples:

Go to the source code of this file.