t2dSceneWindow
Hierarchy:
This object is derived from:
Object's derived from this:
Methods:
completeCameraMove()
Description: Complete Camera Move.
dismount()
Description: Dismounts Camera from object.
getCanvasPoint(X/Y)
Description: Returns Canvas coordinate of Window coordinate.
getCurrentCameraArea()
Description: Get current camera Area.
getCurrentCameraPosition()
Description: Get current camera Position.
getCurrentCameraSize()
Description: Get current camera Size.
getCurrentCameraZoom()
Description: Get current camera Zoom.
getIsCameraMounted()
Description: Is Camera Mounted Status.
getIsCameraMoving()
Description: Is Camera Moving Status.
getIsWindowPoint(X/Y)
Description: Checks if World coordinate is inside Window.
getLockMouse()
Description: Gets the window mouse-lock status.
getMousePosition()
Description: Gets Current Mouse Position.
getRenderGroupMask()
Description: Gets the group mask which controls what is rendered.
getRenderLayerMask()
Description: Gets the layer mask which controls what is rendered.
getSceneGraph()
Description: Returns the associated with this window.
getUseObjectMouseEvents()
Description: Gets whether mouses-events are monitored by the scene-objects.
getUseWindowMouseEvents()
Description: Gets whether mouses-events are monitored by the window.
getWindowExtents()
Description: Fetch Window Extents (Pos/Size).
getWindowPoint(X/Y)
Description: Returns Window coordinate of World coordinate.
getWorldPoint(X/Y)
Description: Returns World coordinate of Window coordinate.
mount(t2dSceneObject,[offsetX/offsetY],[mountForce],[sendToMount?])
Description: Mounts Camera onto a specified object.
resetSceneGraph()
Description: Detaches the window from any Object.
setCameraInterpolationMode(interpolationMode)
Description: Set camera interpolation mode.
setCameraInterpolationTime(interpolationTime)
Description: Set camera interpolation time.
setCurrentCameraArea(x1/y1/x2/y2)
Description: Set current camera area.
setCurrentCameraPosition(x/y/[width/height])
Description: Set current camera position.
setCurrentCameraZoom(zoomFactor)
Description: Set current camera Zoom Factor.
setDebugBanner(fontName, fontSize, textR/G/B/[A]$, backgroundR/G/B/[A]$)
Description: Set Debug Font/Size/textColour/backgroundColour
setLockMouse()
Description: Sets the window mouse-lock status.
setMousePosition()
Description: Sets Current Mouse Position.
setObjectMouseEventFilter()
Description: groupMask, layerMask, [useInvisible?] - Sets Filter for Object Mouse-Events.
setObjectMouseEventGroupFilter(groups $)
Description: Sets the group filter.
setObjectMouseEventInvisibleFilter()
Description: useInvisible - Sets the use invisible flag
setObjectMouseEventLayerFilter(layers $)
Description: Sets the layer filter.
setRenderGroups(groups $)
Description: Sets the render group(s).
setRenderLayers(layers $)
Description: Sets the render layers(s).
setRenderMasks(layerMask, groupMask)
Description: Sets the layer/group mask which control what is rendered.
setSceneGraph(t2dSceneGraph)
Description: Associates Object.
setTargetCameraArea(x/y/width/height)
Description: Set target camera area.
setTargetCameraPosition(x/y/[width/height])
Description: Set target camera position.
setTargetCameraZoom(zoomFactor)
Description: Set target camera Zoom Factor.
setUseObjectMouseEvents(mouseStatus)
Description: Sets whether mouses-events are monitored by the scene-Objects.
setUseWindowMouseEvents(mouseStatus)
Description: Sets whether mouses-events are monitored by the window.
setViewLimitOff()
Description: Set View Limit Off.
setViewLimitOn([minX/minY/maxX/maxY])
Description: Set View Limit On.
startCameraMove([interpolationTime])
Description: Start Camera Move.
startCameraShake(shakeMagnitude, time)
Description: Starts the camera shaking.
stopCameraMove()
Description: Stop Camera Move.
stopCameraShake()
Description: Stops the camera shaking.
undoCameraMove([interpolationTime])
Description: Undo Camera Move.
Callbacks:
onExtentChange(%this, %newExtent)
Brief Description: The size of the scene window changed. This is the size of the GuiControl, not the camera area.
Params:
this: The t2dSceneWindow whose size changed.
fontSize:
onMouseMove(%this, %modifier, %worldPosition, %clicks)
Brief Description: A mouse event occurred in the scene window.
Params:
this: The t2dSceneWindow receiving the mouse event.
modifier: The modifier keys that are pressed.
Possible Values
- Bit 0: Left Shift
- Bit 1: Right Shift
- Bit 2: Left Control
- Bit 3: Right Control
- Bit 4: Left Alt (Windows) or Command (Mac)
- Bit 5: Right Alt (Windows) or Command (Mac)
- Bit 6: Left Option (Mac)
- Bit 7: Right Option (Mac
worldPosition: The current mouse position.
clicks:
onMouseEnter(%this, %modifier, %worldPosition, %clicks)
Brief Description: A mouse event occurred in the scene window.
Params:
this: The t2dSceneWindow receiving the mouse event.
modifier: The modifier keys that are pressed.
Possible Values
- Bit 0: Left Shift
- Bit 1: Right Shift
- Bit 2: Left Control
- Bit 3: Right Control
- Bit 4: Left Alt (Windows) or Command (Mac)
- Bit 5: Right Alt (Windows) or Command (Mac)
- Bit 6: Left Option (Mac)
- Bit 7: Right Option (Mac
worldPosition: The current mouse position.
clicks:
onMouseLeave(%this, %modifier, %worldPosition, %clicks)
Brief Description: A mouse event occurred in the scene window.
Params:
this: The t2dSceneWindow receiving the mouse event.
modifier: The modifier keys that are pressed.
Possible Values
- Bit 0: Left Shift
- Bit 1: Right Shift
- Bit 2: Left Control
- Bit 3: Right Control
- Bit 4: Left Alt (Windows) or Command (Mac)
- Bit 5: Right Alt (Windows) or Command (Mac)
- Bit 6: Left Option (Mac)
- Bit 7: Right Option (Mac
worldPosition: The current mouse position.
clicks:
onMouseDown(%this, %modifier, %worldPosition, %clicks)
Brief Description: A mouse event occurred in the scene window.
Params:
this: The t2dSceneWindow receiving the mouse event.
modifier: The modifier keys that are pressed.
Possible Values
- Bit 0: Left Shift
- Bit 1: Right Shift
- Bit 2: Left Control
- Bit 3: Right Control
- Bit 4: Left Alt (Windows) or Command (Mac)
- Bit 5: Right Alt (Windows) or Command (Mac)
- Bit 6: Left Option (Mac)
- Bit 7: Right Option (Mac
worldPosition: The current mouse position.
clicks:
onMouseDragged(%this, %modifier, %worldPosition, %clicks)
Brief Description: A mouse event occurred in the scene window.
Params:
this: The t2dSceneWindow receiving the mouse event.
modifier: The modifier keys that are pressed.
Possible Values
- Bit 0: Left Shift
- Bit 1: Right Shift
- Bit 2: Left Control
- Bit 3: Right Control
- Bit 4: Left Alt (Windows) or Command (Mac)
- Bit 5: Right Alt (Windows) or Command (Mac)
- Bit 6: Left Option (Mac)
- Bit 7: Right Option (Mac
worldPosition: The current mouse position.
clicks:
onMouseUp(%this, %modifier, %worldPosition, %clicks)
Brief Description: A mouse event occurred in the scene window.
Params:
this: The t2dSceneWindow receiving the mouse event.
modifier: The modifier keys that are pressed.
Possible Values
- Bit 0: Left Shift
- Bit 1: Right Shift
- Bit 2: Left Control
- Bit 3: Right Control
- Bit 4: Left Alt (Windows) or Command (Mac)
- Bit 5: Right Alt (Windows) or Command (Mac)
- Bit 6: Left Option (Mac)
- Bit 7: Right Option (Mac
worldPosition: The current mouse position.
clicks:
onRightMouseDown(%this, %modifier, %worldPosition, %clicks)
Brief Description: A mouse event occurred in the scene window.
Params:
this: The t2dSceneWindow receiving the mouse event.
modifier: The modifier keys that are pressed.
Possible Values
- Bit 0: Left Shift
- Bit 1: Right Shift
- Bit 2: Left Control
- Bit 3: Right Control
- Bit 4: Left Alt (Windows) or Command (Mac)
- Bit 5: Right Alt (Windows) or Command (Mac)
- Bit 6: Left Option (Mac)
- Bit 7: Right Option (Mac
worldPosition: The current mouse position.
clicks:
onRightMouseDragged(%this, %modifier, %worldPosition, %clicks)
Brief Description: A mouse event occurred in the scene window.
Params:
this: The t2dSceneWindow receiving the mouse event.
modifier: The modifier keys that are pressed.
Possible Values
- Bit 0: Left Shift
- Bit 1: Right Shift
- Bit 2: Left Control
- Bit 3: Right Control
- Bit 4: Left Alt (Windows) or Command (Mac)
- Bit 5: Right Alt (Windows) or Command (Mac)
- Bit 6: Left Option (Mac)
- Bit 7: Right Option (Mac
worldPosition: The current mouse position.
clicks:
onRightMouseUp(%this, %modifier, %worldPosition, %clicks)
Brief Description: A mouse event occurred in the scene window.
Params:
this: The t2dSceneWindow receiving the mouse event.
modifier: The modifier keys that are pressed.
Possible Values
- Bit 0: Left Shift
- Bit 1: Right Shift
- Bit 2: Left Control
- Bit 3: Right Control
- Bit 4: Left Alt (Windows) or Command (Mac)
- Bit 5: Right Alt (Windows) or Command (Mac)
- Bit 6: Left Option (Mac)
- Bit 7: Right Option (Mac
worldPosition: The current mouse position.
clicks:
Fields:
lockMouse
Type: bool
useObjectMouseEvents
Type: bool
useWindowMouseEvents
Type: bool
Inherited Fields:
Accelerator
Type: string
AltCommand
Type: string
canSave
Type: bool
Command
Type: string
Extent
Type: Point2I
HorizSizing
Type: enumval
MinExtent
Type: Point2I
Modal
Type: deprecated
Position
Type: Point2I
Profile
Type: GuiProfile
setFirstResponder
Type: deprecated
Variable
Type: string
VertSizing
Type: enumval
Visible
Type: bool
canSaveDynamicFields
Type: bool
internalName
Type: string
parentGroup
Description: Group hierarchy parent of the object.
Type: SimObjectPtr
class
Description: Script SuperClass of object.
Type: string
superclass
Description: Script Class of object.
Type: string
hovertime
Type: int
ToolTip
Type: string
tooltipprofile
Type: GuiProfile
isContainer
Type: bool
langTableMod
Type: string