ViewXtWindow
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 ViewXtWindow object is derived from the Object object.
Property List
Method List
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object object.)
- ExportImage (filename string, fileformat string)
- Export the view window image at its same size to a specified file.
- ExportImage (filename string, fileformat string, imagewidth number, imageheight number)
- Export the view window image at the given size to a specified file.
- ExportImage (filename string, fileformat string, imagesize ImageSizeEnum)
- Export the view window image at a predefined size to a specified file.
- 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.)
- 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.
- TransformView (origin Point, direction Point, zoomDistance number)
- Transform the 3D view by specified arguments.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
Method Details
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (duplicated) entity.
- ExportImage (filename string, fileformat string)
- Export the view window image at its same size to a specified file.
- ExportImage (filename string, fileformat string, imagewidth number, imageheight number)
- Export the view window image at the given size to a specified file.
- ExportImage (filename string, fileformat string, imagesize ImageSizeEnum)
- Export the view window image at a predefined size to a specified file.
- Input Parameters
- filename(string)
- The name of the image file without its extension.
- fileformat(string)
- The image file format, e.g. jpg, png, pdf, etc.
- imagesize(ImageSizeEnum)
- The image size enum option, e.g. VGA, SVGA, etc.
- 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.
- 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.
- TransformView (origin Point, direction Point, zoomDistance number)
- Transform the 3D view by specified arguments.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.