Inherits GuiControl, and GuiControl.

Methods
bool	addInputListener (inputListener)

bool	addInputListener (inputListener)

void	clampCameraViewLimit ()

void	clampCameraViewLimit ()

void	completeCameraMove ()

void	completeCameraMove ()

void	dismount ()

void	dismount ()

string	getBackgroundColor (float red/float green/float blue/float alpha)

string	getBackgroundColor (float red/float green/float blue/float alpha)

float	getCameraAngle ()

float	getCameraAngle ()

string	getCameraArea ()

string	getCameraArea ()

string	getCameraPosition ()

string	getCameraPosition ()

string	getCameraRenderPosition ()

string	getCameraRenderPosition ()

string	getCameraRenderScale ()

string	getCameraRenderScale ()

string	getCameraSize ()

string	getCameraSize ()

string	getCameraWorldScale ()

string	getCameraWorldScale ()

float	getCameraZoom ()

float	getCameraZoom ()

string	getCanvasPoint (X/Y)

string	getCanvasPoint (X/Y)

bool	getIsCameraMounted ()

bool	getIsCameraMounted ()

bool	getIsCameraMoving ()

bool	getIsCameraMoving ()

bool	getIsWindowPoint (X/Y)

bool	getIsWindowPoint (X/Y)

bool	getLockMouse ()

bool	getLockMouse ()

string	getMousePosition ()

string	getMousePosition ()

int	getRenderGroupMask ()

int	getRenderGroupMask ()

int	getRenderLayerMask ()

int	getRenderLayerMask ()

string	getScene ()

string	getScene ()

float	getTargetCameraAngle ()

float	getTargetCameraAngle ()

string	getTargetCameraArea ()

string	getTargetCameraArea ()

string	getTargetCameraPosition ()

string	getTargetCameraPosition ()

string	getTargetCameraSize ()

string	getTargetCameraSize ()

float	getTargetCameraZoom ()

float	getTargetCameraZoom ()

bool	getUseBackgroundColor ()

bool	getUseBackgroundColor ()

bool	getUseObjectInputEvents ()

bool	getUseObjectInputEvents ()

bool	getUseWindowInputEvents ()

bool	getUseWindowInputEvents ()

string	getWindowExtents ()

string	getWindowExtents ()

string	getWindowPoint (X/Y)

string	getWindowPoint (X/Y)

string	getWorldPoint (X/Y)

string	getWorldPoint (X/Y)

void	mount (sceneObject,[offsetX/offsetY],[mountForce],[sendToMount?],[mountAngle?])

void	mount (sceneObject,[offsetX/offsetY],[mountForce],[sendToMount?],[mountAngle?])

bool	removeInputListener (inputListener)

bool	removeInputListener (inputListener)

void	resetScene ()

void	resetScene ()

void	setBackgroundColor (float red, float green, float blue,[float alpha=1.0])

void	setBackgroundColor (float red, float green, float blue,[float alpha=1.0])

void	setCameraAngle (angle)

void	setCameraAngle (angle)

void	setCameraArea (x1/y1/x2/y2)

void	setCameraArea (x1/y1/x2/y2)

void	setCameraInterpolationMode (interpolationMode)

void	setCameraInterpolationMode (interpolationMode)

void	setCameraInterpolationTime (interpolationTime)

void	setCameraInterpolationTime (interpolationTime)

void	setCameraPosition (x, y)

void	setCameraPosition (x, y)

void	setCameraSize (width, height)

void	setCameraSize (width, height)

void	setCameraZoom (zoomFactor)

void	setCameraZoom (zoomFactor)

void	setLockMouse (bool lockSet)

void	setLockMouse (bool lockSet)

void	setMousePosition (x/y)

void	setMousePosition (x/y)

void	setObjectInputEventFilter (groupMask, layerMask,[useInvisibleFilter?])

void	setObjectInputEventFilter (groupMask, layerMask,[useInvisibleFilter?])

void	setObjectInputEventGroupFilter (groups $)

void	setObjectInputEventGroupFilter (groups $)

void	setObjectInputEventInvisibleFilter (bool useInvisibleFilter)

void	setObjectInputEventInvisibleFilter (bool useInvisibleFilter)

void	setObjectInputEventLayerFilter (layers $)

void	setObjectInputEventLayerFilter (layers $)

void	setRenderGroups (groups $)

void	setRenderGroups (groups $)

void	setRenderLayers (layers $)

void	setRenderLayers (layers $)

void	setRenderMasks (layerMask, groupMask)

void	setRenderMasks (layerMask, groupMask)

void	setScene (Scene)

void	setScene (Scene)

void	setTargetCameraAngle (angle)

void	setTargetCameraAngle (angle)

void	setTargetCameraArea (x/y/width/height)

void	setTargetCameraArea (x/y/width/height)

void	setTargetCameraPosition (x, y)

void	setTargetCameraPosition (x, y)

void	setTargetCameraSize (width, height)

void	setTargetCameraSize (width, height)

void	setTargetCameraZoom (zoomFactor)

void	setTargetCameraZoom (zoomFactor)

void	setUseBackgroundColor ()

void	setUseBackgroundColor ()

void	setUseObjectInputEvents (inputStatus)

void	setUseObjectInputEvents (inputStatus)

void	setUseWindowInputEvents (inputStatus)

void	setUseWindowInputEvents (inputStatus)

void	setViewLimitOff ()

void	setViewLimitOff ()

void	setViewLimitOn ([minX/minY/maxX/maxY])

void	setViewLimitOn ([minX/minY/maxX/maxY])

void	startCameraMove ([interpolationTime])

void	startCameraMove ([interpolationTime])

void	startCameraShake (shakeMagnitude, time)

void	startCameraShake (shakeMagnitude, time)

void	stopCameraMove ()

void	stopCameraMove ()

void	stopCameraShake ()

void	stopCameraShake ()

void	undoCameraMove ([interpolationTime])

void	undoCameraMove ([interpolationTime])

Methods inherited from GuiControl
void	addGuiControl (int controlId)

void	addGuiControl (int controlId)

int	findHitControl (int x, int y)

int	findHitControl (int x, int y)

string	getCenter ()

string	getCenter ()

string	getExtent ()

string	getExtent ()

string	getGlobalCenter ()

string	getGlobalCenter ()

string	getGlobalPosition ()

string	getGlobalPosition ()

string	getMinExtent ()

string	getMinExtent ()

int	getParent ()

int	getParent ()

string	getPosition ()

string	getPosition ()

string	getValue ()

string	getValue ()

bool	isActive ()

bool	isActive ()

bool	isAwake ()

bool	isAwake ()

bool	isVisible ()

bool	isVisible ()

void	makeFirstResponder (isFirst)

void	makeFirstResponder (isFirst)

bool	pointInControl (int x, int y)

bool	pointInControl (int x, int y)

void	reorderChild (child1, child2)

void	reorderChild (child1, child2)

void	resize (int x, int y, int w, int h)

void	resize (int x, int y, int w, int h)

void	setActive (isActive)

void	setActive (isActive)

void	setCanSave (bool canSave)

void	setCanSave (bool canSave)

void	setCenter (int x, int y)

void	setCenter (int x, int y)

void	setExtent (int width, int height)

void	setExtent (int width, int height)

void	setFirstResponder ()

void	setFirstResponder ()

void	setPosition (int x, int y)

void	setPosition (int x, int y)

void	setPositionGlobal (int x, int y)

void	setPositionGlobal (int x, int y)

void	setProfile (GuiControlProfile p)

void	setProfile (GuiControlProfile p)

void	setValue (value)

void	setValue (value)

void	setVisible (isVisible)

void	setVisible (isVisible)

Fields
ColorF	BackgroundColor

bool	lockMouse

bool	UseBackgroundColor

bool	UseObjectInputEvents

bool	UseWindowInputEvents

SimBase
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

Namespace Linking
string	superclass

string	class

Gui Editing
bool	isContainer

GuiControl
GuiProfile	Profile

enumval	HorizSizing

enumval	VertSizing

Point2I	Position

Point2I	Extent

Point2I	MinExtent

bool	canSave

bool	Visible

deprecated	Modal

deprecated	setFirstResponder

string	Variable

string	Command

string	AltCommand

string	Accelerator

bool	Active

ToolTip
GuiProfile	tooltipprofile

string	ToolTip

int	tooltipWidth

int	hovertime

Localization
string	langTableMod

Fields inherited from GuiControl
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

bool	isContainer

GuiProfile	Profile

enumval	HorizSizing

enumval	VertSizing

Point2I	Position

Point2I	Extent

Point2I	MinExtent

bool	canSave

bool	Visible

deprecated	Modal

deprecated	setFirstResponder

string	Variable

string	Command

string	AltCommand

string	Accelerator

bool	Active

GuiProfile	tooltipprofile

string	ToolTip

int	tooltipWidth

int	hovertime

string	langTableMod

Fields inherited from SimGroup
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

Fields inherited from SimSet
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

Fields inherited from SimObject
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

Methods

bool SceneWindow::addInputListener ( inputListener )

Adds an object as an input listener.

Parameters

inputListener The object to add as an input listener.

Returns: Whether the object was added as an input event listener or not.

bool SceneWindow::addInputListener ( inputListener )

Adds an object as an input listener.

Parameters

inputListener The object to add as an input listener.

Returns: Whether the object was added as an input event listener or not.

void SceneWindow::clampCameraViewLimit ( )

Clamps the current camera to the current view limit. Nothing will happen if the view-limit is not active or the camera is moving.

Returns: No return value

void SceneWindow::clampCameraViewLimit ( )

Clamps the current camera to the current view limit. Nothing will happen if the view-limit is not active or the camera is moving.

Returns: No return value

void SceneWindow::completeCameraMove ( )

Moves camera directly to target.

Returns: No return value.

void SceneWindow::completeCameraMove ( )

Moves camera directly to target.

Returns: No return value.

void SceneWindow::dismount ( )

Dismounts Camera from object.

Returns: No return value

void SceneWindow::dismount ( )

Dismounts Camera from object.

Returns: No return value

string SceneWindow::getBackgroundColor ( float red/float green/float blue/float alpha )

The background color for the scene.

string SceneWindow::getBackgroundColor ( float red/float green/float blue/float alpha )

The background color for the scene.

float SceneWindow::getCameraAngle ( )

Gets the current camera angle.

Returns: The current camera angle in degrees.

float SceneWindow::getCameraAngle ( )

Gets the current camera angle.

Returns: The current camera angle in degrees.

string SceneWindow::getCameraArea ( )

Get the current camera Area.

Returns: The camera area formatted as "x1 y1 x2 y2"

string SceneWindow::getCameraArea ( )

Get the current camera Area.

Returns: The camera area formatted as "x1 y1 x2 y2"

string SceneWindow::getCameraPosition ( )

Get the current camera position.

Returns: The current camera position.

string SceneWindow::getCameraPosition ( )

Get the current camera position.

Returns: The current camera position.

string SceneWindow::getCameraRenderPosition ( )

Get current camera position post-view-limit clamping.

Returns: The current camera render position.

string SceneWindow::getCameraRenderPosition ( )

Get current camera position post-view-limit clamping.

Returns: The current camera render position.

string SceneWindow::getCameraRenderScale ( )

Get current camera scale to render.

Returns: Returns the cameras window width/height scale to render as a string formatted as "widthScale heightScale"

string SceneWindow::getCameraRenderScale ( )

Get current camera scale to render.

Returns: Returns the cameras window width/height scale to render as a string formatted as "widthScale heightScale"

string SceneWindow::getCameraSize ( )

Get the current camera size.

Returns: The current camera width and height.

string SceneWindow::getCameraSize ( )

Get the current camera size.

Returns: The current camera width and height.

string SceneWindow::getCameraWorldScale ( )

Get current camera scale to world.

Returns: Returns the cameras window width/height scale to world as a string formatted as "widthScale heightScale"

string SceneWindow::getCameraWorldScale ( )

Get current camera scale to world.

Returns: Returns the cameras window width/height scale to world as a string formatted as "widthScale heightScale"

float SceneWindow::getCameraZoom ( )

Get the current camera Zoom.

Returns: The current camera zoom.

float SceneWindow::getCameraZoom ( )

Get the current camera Zoom.

Returns: The current camera zoom.

string SceneWindow::getCanvasPoint ( X/ Y )

Returns Canvas coordinate of Window coordinate.
Parameters

x,y The coordinates in world coordinates you wish to convert to window coordinates. Accepts either (x,y) or ("x y")

Returns
Returns the desired canvas coordinates as a string formatted as "x y"

string SceneWindow::getCanvasPoint ( X/ Y )

Returns Canvas coordinate of Window coordinate.
Parameters

x,y The coordinates in world coordinates you wish to convert to window coordinates. Accepts either (x,y) or ("x y")

Returns
Returns the desired canvas coordinates as a string formatted as "x y"

bool SceneWindow::getIsCameraMounted ( )

Check the camera mounted status.

Returns: Returns a boolean value as to whether or not the camera is mounted.

bool SceneWindow::getIsCameraMounted ( )

Check the camera mounted status.

Returns: Returns a boolean value as to whether or not the camera is mounted.

bool SceneWindow::getIsCameraMoving ( )

Check the camera moving status.

Returns: Returns a boolean value as to whether or not the camera is moving.

bool SceneWindow::getIsCameraMoving ( )

Check the camera moving status.

Returns: Returns a boolean value as to whether or not the camera is moving.

bool SceneWindow::getIsWindowPoint ( X/ Y )

Checks if World coordinate is inside Window.

Parameters

x,y	The coordinates in world coordinates you wish to check. Accepts either (x,y) or ("x y")

Returns: Returns true if the coordinates are within the window, and false otherwise.

bool SceneWindow::getIsWindowPoint ( X/ Y )

Checks if World coordinate is inside Window.

Parameters

x,y	The coordinates in world coordinates you wish to check. Accepts either (x,y) or ("x y")

Returns: Returns true if the coordinates are within the window, and false otherwise.

bool SceneWindow::getLockMouse ( )

Gets the window mouse-lock status.

bool SceneWindow::getLockMouse ( )

Gets the window mouse-lock status.

string SceneWindow::getMousePosition ( )

Gets Current Mouse Position.

Returns: Returns a string with the current mouse cursor coordinates formatted as "x y"

string SceneWindow::getMousePosition ( )

Gets Current Mouse Position.

Returns: Returns a string with the current mouse cursor coordinates formatted as "x y"

int SceneWindow::getRenderGroupMask ( )

Gets the group mask which controls what is rendered.
Returns
The bit mask corresponding to the groups which are to be rendered

int SceneWindow::getRenderGroupMask ( )

Gets the group mask which controls what is rendered.
Returns
The bit mask corresponding to the groups which are to be rendered

int SceneWindow::getRenderLayerMask ( )

Gets the layer mask which controls what is rendered.
Returns
The bit mask corresponding to the layers which are to be rendered

int SceneWindow::getRenderLayerMask ( )

Gets the layer mask which controls what is rendered.
Returns
The bit mask corresponding to the layers which are to be rendered

string SceneWindow::getScene ( )

Returns the Scene associated with this window.
Returns
Returns the scene ID as a string

string SceneWindow::getScene ( )

Returns the Scene associated with this window.
Returns
Returns the scene ID as a string

float SceneWindow::getTargetCameraAngle ( )

Gets the target camera angle.

Returns: The target camera angle in degrees.

float SceneWindow::getTargetCameraAngle ( )

Gets the target camera angle.

Returns: The target camera angle in degrees.

string SceneWindow::getTargetCameraArea ( )

Get the target camera Area.

Returns: The camera area formatted as "x1 y1 x2 y2"

string SceneWindow::getTargetCameraArea ( )

Get the target camera Area.

Returns: The camera area formatted as "x1 y1 x2 y2"

string SceneWindow::getTargetCameraPosition ( )

Get the target camera position.

Returns: The target camera position.

string SceneWindow::getTargetCameraPosition ( )

Get the target camera position.

Returns: The target camera position.

string SceneWindow::getTargetCameraSize ( )

Get the target camera size.

Returns: The target camera width and height.

string SceneWindow::getTargetCameraSize ( )

Get the target camera size.

Returns: The target camera width and height.

float SceneWindow::getTargetCameraZoom ( )

Get the target camera Zoom.

Returns: The current camera zoom.

float SceneWindow::getTargetCameraZoom ( )

Get the target camera Zoom.

Returns: The current camera zoom.

bool SceneWindow::getUseBackgroundColor ( )

Gets whether the scene background color is in use or not.

Returns: Whether the scene background color is in use or not.

bool SceneWindow::getUseBackgroundColor ( )

Gets whether the scene background color is in use or not.

Returns: Whether the scene background color is in use or not.

bool SceneWindow::getUseObjectInputEvents ( )

Gets whether input events are passed onto scene objects or not.

Returns: Whether input events are passed onto scene objects or not..

bool SceneWindow::getUseObjectInputEvents ( )

Gets whether input events are passed onto scene objects or not.

Returns: Whether input events are passed onto scene objects or not..

bool SceneWindow::getUseWindowInputEvents ( )

Gets whether input events are monitored by the window or not.

Returns: Whether input events are monitored by the window or not.

bool SceneWindow::getUseWindowInputEvents ( )

Gets whether input events are monitored by the window or not.

Returns: Whether input events are monitored by the window or not.

string SceneWindow::getWindowExtents ( )

Fetch Window Extents (Position/Size).

Returns: Returns the window dimensions as a string formatted as follows: <position.x> <position.y> <width> <height>

string SceneWindow::getWindowExtents ( )

Fetch Window Extents (Position/Size).

Returns: Returns the window dimensions as a string formatted as follows: <position.x> <position.y> <width> <height>

string SceneWindow::getWindowPoint ( X/ Y )

Returns Window coordinate of World coordinate.
Parameters

x,y The coordinates in world coordinates you wish to convert to window coordinates. Accepts either (x,y) or ("x y")

Returns
Returns the desired window coordinates as a string formatted as "x y"

string SceneWindow::getWindowPoint ( X/ Y )

Returns Window coordinate of World coordinate.
Parameters

x,y The coordinates in world coordinates you wish to convert to window coordinates. Accepts either (x,y) or ("x y")

Returns
Returns the desired window coordinates as a string formatted as "x y"

string SceneWindow::getWorldPoint ( X/ Y )

Returns World coordinate of Window coordinate.
Parameters

x,y The coordinates in window coordinates you wish to convert to world coordinates. Accepts either (x,y) or ("x y")

Returns
Returns the desired world coordinates as a string formatted as "x y"

string SceneWindow::getWorldPoint ( X/ Y )

Returns World coordinate of Window coordinate.
Parameters

x,y The coordinates in window coordinates you wish to convert to world coordinates. Accepts either (x,y) or ("x y")

Returns
Returns the desired world coordinates as a string formatted as "x y"

void SceneWindow::mount ( sceneObject )

Mounts the camera onto the specified object.

Parameters

sceneObject	The scene object to mount the camera to.
offsetX	/ offsetY The offset from the objects position to mount the camera to. Optional: Defaults to no offset.
mountForce	The force to use to keep the camera mounted to the object. Zero is a rigid mount. Optional: Defaults to zero.
sendToMount	Whether to immediately move the camera to the objects position or not. Optional: Defaults to true.
mountAngle	Whether to mount the cameras angle to the objects angle or not. Optional: Defaults to false.

Returns: No return value

void SceneWindow::mount ( sceneObject )

Mounts the camera onto the specified object.

Parameters

sceneObject	The scene object to mount the camera to.
offsetX	/ offsetY The offset from the objects position to mount the camera to. Optional: Defaults to no offset.
mountForce	The force to use to keep the camera mounted to the object. Zero is a rigid mount. Optional: Defaults to zero.
sendToMount	Whether to immediately move the camera to the objects position or not. Optional: Defaults to true.
mountAngle	Whether to mount the cameras angle to the objects angle or not. Optional: Defaults to false.

Returns: No return value

bool SceneWindow::removeInputListener ( inputListener )

Removes an object from being an input listener.

Parameters

inputListener The object to remove as an input listener.

Returns: Whether the object was removed as an input event listener or not.

bool SceneWindow::removeInputListener ( inputListener )

Removes an object from being an input listener.

Parameters

inputListener The object to remove as an input listener.

Returns: Whether the object was removed as an input event listener or not.

void SceneWindow::resetScene ( )

Detaches the window from any Scene Object.

Returns: No return value

void SceneWindow::resetScene ( )

Detaches the window from any Scene Object.

Returns: No return value

void SceneWindow::setBackgroundColor	(	float	red,
		float	green,
		float	blue
	)

or ( stockColorName ) - Sets the background color for the scene.

Parameters

red	The red value.
green	The green value.
blue	The blue value.
alpha	The alpha value.

Returns: No return Value.

void SceneWindow::setBackgroundColor	(	float	red,
		float	green,
		float	blue
	)

or ( stockColorName ) - Sets the background color for the scene.

Parameters

red	The red value.
green	The green value.
blue	The blue value.
alpha	The alpha value.

Returns: No return Value.

void SceneWindow::setCameraAngle ( angle )

Sets the current camera angle.
Parameters

angle The current camera angle in degrees.

Returns
No return value.

void SceneWindow::setCameraAngle ( angle )

Sets the current camera angle.
Parameters

angle The current camera angle in degrees.

Returns
No return value.

void SceneWindow::setCameraArea ( x1/y1/x2/ y2 )

Set the current camera area.
Parameters

x1,y1,x2,y2 The coordinates of the minimum and maximum points (top left, bottom right) The input can be formatted as either "x1 y1 x2 y2", "x1 y1, x2 y2", "x1, y1, x2, y2"

Returns
No return value.

void SceneWindow::setCameraArea ( x1/y1/x2/ y2 )

Set the current camera area.
Parameters

x1,y1,x2,y2 The coordinates of the minimum and maximum points (top left, bottom right) The input can be formatted as either "x1 y1 x2 y2", "x1 y1, x2 y2", "x1, y1, x2, y2"

Returns
No return value.

void SceneWindow::setCameraInterpolationMode ( interpolationMode )

Set camera interpolation mode.
Returns
No return value.

void SceneWindow::setCameraInterpolationMode ( interpolationMode )

Set camera interpolation mode.
Returns
No return value.

void SceneWindow::setCameraInterpolationTime ( interpolationTime )

Set camera interpolation time.
Returns
No return value

void SceneWindow::setCameraInterpolationTime ( interpolationTime )

Set camera interpolation time.
Returns
No return value

void SceneWindow::setCameraPosition	(	x	,
		y
	)

Set the current camera position.
Parameters

X Position along the X axis.

Y Position along the Y axis.

Returns
No return value.

void SceneWindow::setCameraPosition	(	x	,
		y
	)

Set the current camera position.
Parameters

X Position along the X axis.

Y Position along the Y axis.

Returns
No return value.

void SceneWindow::setCameraSize	(	width	,
		height
	)

Set the current camera position.
Parameters

width Size along the X axis.

height Size along the Y axis.

Returns
No return value.

void SceneWindow::setCameraSize	(	width	,
		height
	)

Set the current camera position.
Parameters

width Size along the X axis.

height Size along the Y axis.

Returns
No return value.

void SceneWindow::setCameraZoom ( zoomFactor )

Set the current camera Zoom Factor.
Parameters

zoomFactor A float value representing the zoom factor

Returns
No return value.

void SceneWindow::setCameraZoom ( zoomFactor )

Set the current camera Zoom Factor.
Parameters

zoomFactor A float value representing the zoom factor

Returns
No return value.

void SceneWindow::setLockMouse ( bool lockSet )

Sets the window mouse-lock status.

Returns: No return value.

void SceneWindow::setLockMouse ( bool lockSet )

Sets the window mouse-lock status.

Returns: No return value.

void SceneWindow::setMousePosition ( x/ y )

Sets Current Mouse Position.

Parameters

x,y	The coordinates to set the mouse cursor. Accepts either (x,y) or ("x y")

void SceneWindow::setMousePosition ( x/ y )

Sets Current Mouse Position.

Parameters

x,y	The coordinates to set the mouse cursor. Accepts either (x,y) or ("x y")

void SceneWindow::setObjectInputEventFilter	(	groupMask	,
		layerMask
	)

Sets input filter for input events.

void SceneWindow::setObjectInputEventFilter	(	groupMask	,
		layerMask
	)

Sets input filter for input events.

void SceneWindow::setObjectInputEventGroupFilter ( groups $ )

Sets the input events group filter.

Parameters

List	of groups to filter input events with.

Returns: No return value.

void SceneWindow::setObjectInputEventGroupFilter ( groups $ )

Sets the input events group filter.

Parameters

List	of groups to filter input events with.

Returns: No return value.

void SceneWindow::setObjectInputEventInvisibleFilter ( bool useInvisibleFilter )

Sets whether invisible objects should be filtered for input events or not.

void SceneWindow::setObjectInputEventInvisibleFilter ( bool useInvisibleFilter )

Sets whether invisible objects should be filtered for input events or not.

void SceneWindow::setObjectInputEventLayerFilter ( layers $ )

Sets the input events layer filter.

Parameters

The	list of layers to filter input events with.

Returns: No return value.

void SceneWindow::setObjectInputEventLayerFilter ( layers $ )

Sets the input events layer filter.

Parameters

The	list of layers to filter input events with.

Returns: No return value.

void SceneWindow::setRenderGroups ( groups $ )

Sets the render group(s).
Parameters

groups The list of groups you wish to set.

Returns
No return value.

void SceneWindow::setRenderGroups ( groups $ )

Sets the render group(s).
Parameters

groups The list of groups you wish to set.

Returns
No return value.

void SceneWindow::setRenderLayers ( layers $ )

Sets the render layers(s).
Parameters

The layer numbers you wish to set.

Returns
No return value.

void SceneWindow::setRenderLayers ( layers $ )

Sets the render layers(s).
Parameters

The layer numbers you wish to set.

Returns
No return value.

void SceneWindow::setRenderMasks	(	layerMask	,
		groupMask
	)

Sets the layer/group mask which control what is rendered.
Parameters

layermask The bitmask for setting the layers to render

groupmask The bitmask for setting the groups to render

Returns
No return value.

void SceneWindow::setRenderMasks	(	layerMask	,
		groupMask
	)

Sets the layer/group mask which control what is rendered.
Parameters

layermask The bitmask for setting the layers to render

groupmask The bitmask for setting the groups to render

Returns
No return value.

void SceneWindow::setScene ( Scene )

Associates Scene Object.

Parameters

Scene The scene ID or name.

Returns: No return value.

void SceneWindow::setScene ( Scene )

Associates Scene Object.

Parameters

Scene The scene ID or name.

Returns: No return value.

void SceneWindow::setTargetCameraAngle ( angle )

Sets the target camera angle.
Parameters

angle The target camera angle in degrees.

Returns
No return value.

void SceneWindow::setTargetCameraAngle ( angle )

Sets the target camera angle.
Parameters

angle The target camera angle in degrees.

Returns
No return value.

void SceneWindow::setTargetCameraArea ( x/y/width/ height )

Set the target camera area.
Returns
No return value.

void SceneWindow::setTargetCameraArea ( x/y/width/ height )

Set the target camera area.
Returns
No return value.

void SceneWindow::setTargetCameraPosition	(	x	,
		y
	)

Set the target camera position.
Parameters

X Position along the X axis.

Y Position along the Y axis.

Returns
No return value.

void SceneWindow::setTargetCameraPosition	(	x	,
		y
	)

Set the target camera position.
Parameters

X Position along the X axis.

Y Position along the Y axis.

Returns
No return value.

void SceneWindow::setTargetCameraSize	(	width	,
		height
	)

Set the target camera position.
Parameters

width Size along the X axis.

height Size along the Y axis.

Returns
No return value.

void SceneWindow::setTargetCameraSize	(	width	,
		height
	)

Set the target camera position.
Parameters

width Size along the X axis.

height Size along the Y axis.

Returns
No return value.

void SceneWindow::setTargetCameraZoom ( zoomFactor )

Set the target camera Zoom Factor.
Returns
No return value.

void SceneWindow::setTargetCameraZoom ( zoomFactor )

Set the target camera Zoom Factor.
Returns
No return value.

void SceneWindow::setUseBackgroundColor ( )

Sets whether to use the scene background color or not.

Parameters

useBackgroundColor Whether to use the scene background color or not.

Returns: No return value.

void SceneWindow::setUseBackgroundColor ( )

Sets whether to use the scene background color or not.

Parameters

useBackgroundColor Whether to use the scene background color or not.

Returns: No return value.

void SceneWindow::setUseObjectInputEvents ( inputStatus )

Sets whether input events are passed onto scene objects or not.

Parameters

mouseStatus Whether input events are passed onto scene objects or not.

void SceneWindow::setUseObjectInputEvents ( inputStatus )

Sets whether input events are passed onto scene objects or not.

Parameters

mouseStatus Whether input events are passed onto scene objects or not.

void SceneWindow::setUseWindowInputEvents ( inputStatus )

Sets whether input events are monitored by the window or not.

Parameters

inputStatus Whether input events are processed by the window or not.

Returns: No return value.

void SceneWindow::setUseWindowInputEvents ( inputStatus )

Sets whether input events are monitored by the window or not.

Parameters

inputStatus Whether input events are processed by the window or not.

Returns: No return value.

void SceneWindow::setViewLimitOff ( )

Set View Limit Off.

Returns: No return value

void SceneWindow::setViewLimitOff ( )

Set View Limit Off.

Returns: No return value

void SceneWindow::setViewLimitOn ( )

Set View Limit On.
Returns
No return value

void SceneWindow::setViewLimitOn ( )

Set View Limit On.
Returns
No return value

void SceneWindow::startCameraMove ( )

Start Camera Move.
Returns
No return value.

void SceneWindow::startCameraMove ( )

Start Camera Move.
Returns
No return value.

void SceneWindow::startCameraShake	(	shakeMagnitude	,
		time
	)

Starts the camera shaking.
Parameters

shakeMagnitude The intensity of the shaking

time The length of the shake

Returns
No return value

void SceneWindow::startCameraShake	(	shakeMagnitude	,
		time
	)

Starts the camera shaking.
Parameters

shakeMagnitude The intensity of the shaking

time The length of the shake

Returns
No return value

void SceneWindow::stopCameraMove ( )

Stops current camera movement

Returns: No return value.

void SceneWindow::stopCameraMove ( )

Stops current camera movement

Returns: No return value.

void SceneWindow::stopCameraShake ( )

Stops the camera shaking.

Returns: No return value

void SceneWindow::stopCameraShake ( )

Stops the camera shaking.

Returns: No return value

void SceneWindow::undoCameraMove ( )

Reverses previous camera movement.
Returns
No return value.

void SceneWindow::undoCameraMove ( )

Reverses previous camera movement.
Returns
No return value.

Member Data Documentation

string SceneWindow::Accelerator

bool SceneWindow::Active

string SceneWindow::AltCommand

ColorF SceneWindow::BackgroundColor

bool SceneWindow::canSave

bool SceneWindow::canSaveDynamicFields

string SceneWindow::class

Script SuperClass of object.

string SceneWindow::Command

Point2I SceneWindow::Extent

enumval SceneWindow::HorizSizing

int SceneWindow::hovertime

string SceneWindow::internalName

bool SceneWindow::isContainer

string SceneWindow::langTableMod

bool SceneWindow::lockMouse

Point2I SceneWindow::MinExtent

deprecated SceneWindow::Modal

SimObjectPtr SceneWindow::parentGroup

Group hierarchy parent of the object.

Point2I SceneWindow::Position

GuiProfile SceneWindow::Profile

deprecated SceneWindow::setFirstResponder

string SceneWindow::superclass

Script Class of object.

string SceneWindow::ToolTip

GuiProfile SceneWindow::tooltipprofile

int SceneWindow::tooltipWidth

bool SceneWindow::UseBackgroundColor

bool SceneWindow::UseObjectInputEvents

bool SceneWindow::UseWindowInputEvents

string SceneWindow::Variable

enumval SceneWindow::VertSizing

bool SceneWindow::Visible

layermask	The bitmask for setting the layers to render
groupmask	The bitmask for setting the groups to render

shakeMagnitude	The intensity of the shaking
time	The length of the shake