SketchUp SDK
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Functions
scene.h File Reference
#include <slapi/slapi.h>
#include <slapi/unicodestring.h>
#include <slapi/model/defs.h>

Go to the source code of this file.

Functions

SU_EXPORT SUEntityRef SUSceneToEntity (SUSceneRef scene)
 Converts from an SUSceneRef to an SUEntityRef. This is essentially an upcast operation. More...
 
SU_EXPORT SUSceneRef SUSceneFromEntity (SUEntityRef entity)
 Converts from an SUEntityRef to an SUSceneRef. This is essentially a downcast operation so the given SUEntityRef must be convertible to an SUSceneRef. More...
 
SU_RESULT SUSceneCreate (SUSceneRef *scene)
 Creates an empty scene object. More...
 
SU_RESULT SUSceneRelease (SUSceneRef *scene)
 Releases a scene object. More...
 
SU_RESULT SUSceneGetUseCamera (SUSceneRef scene, bool *use_camera)
 Retrieves the 'use camera' setting of a scene object. More...
 
SU_RESULT SUSceneGetCamera (SUSceneRef scene, SUCameraRef *camera)
 Retrieves the camera of a scene object. More...
 
SU_RESULT SUSceneGetName (SUSceneRef scene, SUStringRef *name)
 Retrieves the name of a scene object. More...
 
SU_RESULT SUSceneSetName (SUSceneRef scene, const char *scene_name)
 Sets the name of a scene object. More...
 
SU_RESULT SUSceneGetRenderingOptions (SUSceneRef scene, SURenderingOptionsRef *options)
 Retrieves the rendering options for the scene object. More...
 

Function Documentation

SU_RESULT SUSceneCreate ( SUSceneRef scene)

Creates an empty scene object.

Parameters
[out]sceneThe destination of the instantiated page view object.
Returns
SU_EXPORT SUSceneRef SUSceneFromEntity ( SUEntityRef  entity)

Converts from an SUEntityRef to an SUSceneRef. This is essentially a downcast operation so the given SUEntityRef must be convertible to an SUSceneRef.

Parameters
[in]entityThe entity reference.
Returns
  • The converted SUSceneRef if the downcast operation succeeds. If not, the returned reference will be invalid.
SU_RESULT SUSceneGetCamera ( SUSceneRef  scene,
SUCameraRef camera 
)

Retrieves the camera of a scene object.

Parameters
[in]sceneThe scene object.
[out]cameraThe camera object retrieved.
Returns
SU_RESULT SUSceneGetName ( SUSceneRef  scene,
SUStringRef name 
)

Retrieves the name of a scene object.

Parameters
[in]sceneThe scene object.
[out]nameThe name retrieved.
Returns
SU_RESULT SUSceneGetRenderingOptions ( SUSceneRef  scene,
SURenderingOptionsRef options 
)

Retrieves the rendering options for the scene object.

Parameters
[in]sceneThe scene object.
[out]optionsThe options retrieved.
Returns
SU_RESULT SUSceneGetUseCamera ( SUSceneRef  scene,
bool *  use_camera 
)

Retrieves the 'use camera' setting of a scene object.

Parameters
[in]sceneThe scene object.
[out]use_cameraThe setting retrieved.
Returns
SU_RESULT SUSceneRelease ( SUSceneRef scene)

Releases a scene object.

Parameters
[in]sceneThe scene object.
Returns
SU_RESULT SUSceneSetName ( SUSceneRef  scene,
const char *  scene_name 
)

Sets the name of a scene object.

Parameters
[in]sceneThe scene object.
[in]scene_nameThe name of the scene object. Assumed to be UTF-8 encoded.
Returns
SU_EXPORT SUEntityRef SUSceneToEntity ( SUSceneRef  scene)

Converts from an SUSceneRef to an SUEntityRef. This is essentially an upcast operation.

Parameters
[in]sceneThe given scene reference.
Returns
  • The converted SUEntityRef if scene is a valid object. If not, the returned reference will be invalid.