beastapi/beastscene.h Source File

beastscene.h
Go to the documentation of this file.
1 /*
2 Copyright 2014 Autodesk, Inc. All rights reserved.
3 Use of this software is subject to the terms of the Autodesk license agreement
4 provided at the time of installation or download, or which otherwise
5 accompanies this software in either electronic or hard copy form.
6 */
7 
8 
12 #ifndef BEASTSCENE_H
13 #define BEASTSCENE_H
14 
15 #include "beastapitypes.h"
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif // __cplusplus
20 
24  typedef enum {
32 
33 
41  ILB_DLL_FUNCTION ILBStatus ILBBeginScene(ILBManagerHandle beastManager,
42  ILBConstString uniqueName,
43  ILBSceneHandle* target);
44 
52  ILB_DLL_FUNCTION ILBStatus ILBBeginPhysicalScene(ILBManagerHandle beastManager,
53  ILBConstString uniqueName,
54  ILBSceneHandle* target);
55 
61  ILB_DLL_FUNCTION ILBStatus ILBReleaseScene(ILBSceneHandle scene);
62 
69  ILB_DLL_FUNCTION ILBStatus ILBEndScene(ILBSceneHandle scene);
70 
79  ILB_DLL_FUNCTION ILBStatus ILBSetMeterPerWorldUnit(ILBSceneHandle scene, float meterPerWorldUnit);
80 
88  ILB_DLL_FUNCTION ILBStatus ILBSetSceneUpVector(ILBSceneHandle scene, ILBSceneUpVector upVector);
89 
97  ILB_DLL_FUNCTION ILBStatus ILBGetMeterPerWorldUnit(ILBSceneInfoHandle scene, float* meterPerWorldUnit);
98 
106  ILB_DLL_FUNCTION ILBStatus ILBGetSceneUpVector(ILBSceneInfoHandle scene, ILBSceneUpVector* upVector);
107 
108 #ifdef __cplusplus
109 }
110 #endif // __cplusplus
111 
112 
113 #endif // BEASTSCENE_H
ILBStatus ILBGetSceneUpVector(ILBSceneInfoHandle scene, ILBSceneUpVector *upVector)
Gets the up vector of the scene.
Handle for Beast scene information node Intentionally hidden implementation.
Definition: beastapitypes.h:415
ILBSceneUpVector
The scene up vector.
Definition: beastscene.h:24
Definition: beastscene.h:27
ILBStatus ILBSetMeterPerWorldUnit(ILBSceneHandle scene, float meterPerWorldUnit)
Sets how many meters a world unit in represents for the scene.
This header is the base for getting platform consistent types for the Beast API.
ILBStatus ILBGetMeterPerWorldUnit(ILBSceneInfoHandle scene, float *meterPerWorldUnit)
Gets how many meters a world unit in represents for the scene.
const ILBCharType * ILBConstString
Beast api const string type.
Definition: beastapitypes.h:245
Definition: beastscene.h:26
Definition: beastscene.h:30
Definition: beastscene.h:29
Definition: beastscene.h:25
ILBStatus ILBBeginPhysicalScene(ILBManagerHandle beastManager, ILBConstString uniqueName, ILBSceneHandle *target)
Begins creation of a scene that will use physical materials set up with OSL shaders.
ILBStatus ILBEndScene(ILBSceneHandle scene)
Finalizes this scene Any future call to modify this scene or any of its objects will fail...
ILBStatus ILBBeginScene(ILBManagerHandle beastManager, ILBConstString uniqueName, ILBSceneHandle *target)
Begins creation of a scene that will use "classic" fixed-function materials.
ILBStatus ILBSetSceneUpVector(ILBSceneHandle scene, ILBSceneUpVector upVector)
Sets the up vector of the scene.
Definition: beastscene.h:28
ILBStatus ILBReleaseScene(ILBSceneHandle scene)
Releases the scene data.
Handle for Beast managers Intentionally hidden implementation.
Handle for Beast scenes Intentionally hidden implementation.
Definition: beastapitypes.h:408
ILBStatus
Status codes for Beast API calls.
Definition: beastapitypes.h:153