`MdiSubWindow`

A 3D model view window.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

    -- Create a large cuboid

cube = project.Contents.Geometry:AddCuboid(cf.Point(0,0,0), 10, 10, 10)

    -- Get the first view

view1 = application.MainWindow.MdiArea[1]

    -- Zoom to extents on the view

view1.ViewWindow.View:ZoomToExtents()

Inheritance

The MdiSubWindow object is derived from the Object object.

The following objects are derived (specialisations) from the MdiSubWindow object:

SchematicViewMdiSubWindow

Usage locations

The MdiSubWindow object can be accessed from the following locations:

Properties
Methods
- MdiArea collection has method Item(number).
- MdiArea collection has method Item(string).

Property List

Height: The height of the view window. (Read/Write number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)
Width: The width of the view window. (Read/Write number)
WindowActive: True if this window is the active window. (Read only boolean)
XPosition: The X position of the view window. (Read/Write number)
YPosition: The Y position of the view window. (Read/Write number)

Method List

Close (): Close the view window. (Returns a boolean object.)
Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
GetProperties (): Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
Maximise (): Maximise the view window.
Minimise (): Minimise the view window.
Restore (): Restore the view window.
SetPosition (xposition number, yposition number): Sets the view position. Note that the view is restored when this function is called.
SetProperties (properties Object): Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
SetSize (imagewidth number, imageheight number): Sets the view window size. Note that the view is restored when this function is called.
Show (): Shows the view window.

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Height

The height of the view window.

Type: number
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Width

The width of the view window.

Type: number
Access: Read/Write

WindowActive

True if this window is the active window.

Type: boolean
Access: Read only

XPosition

The X position of the view window.

Type: number
Access: Read/Write

YPosition

The Y position of the view window.

Type: number
Access: Read/Write

Method Details

Close ()

Close the view window.

Return

boolean: Returns true if the window was closed successfully.

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

GetProperties ()

Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.

Return

table: A table defining the properties.

Maximise ()

Maximise the view window.

Minimise ()

Minimise the view window.

Restore ()

Restore the view window.

SetPosition (xposition number, yposition number)

Sets the view position. Note that the view is restored when this function is called.

Input Parameters

xposition(number): The view window X position.
yposition(number): The view window Y position.

SetProperties (properties Object)

Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Input Parameters

properties(Object): A table of properties defining the new state of the object.

SetSize (imagewidth number, imageheight number)

Sets the view window size. Note that the view is restored when this function is called.

Input Parameters

imagewidth(number): The view window width in pixels.
imageheight(number): The view window height in pixels.

Show ()

Shows the view window.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.