Software Customisation
Reference Manual
Summary of Objects, Members and Methods
:
Object Type Details
: ViewFinder
ViewFinder
The ViewFinder object is to allow the Draw PML user to create a frame in the 3d view which represents the view frame in the 2d view. Once drawn, the frame can be moved, rotated, change its representation (but not its size). By manipulating the frame in the 3d view, you can modify the view parameters in the current drawing.
Set-up Methods
Name
Purpose
.viewFinder(DBREF)
Creates a viewfinder object based on the parameters of the Draw View. The input argument must be the dbref of a valid View.
.view(DBREF)
Sets the associated View object using the DBREF which must be a valid view
Methods
Name
Result
Purpose
.redraw()
No Result
Redraws the box using current state of View parameters
.update3d()
No Result
Regenerates frame and 3d model view from the 2d view
.colour ( REAL)
No Result
Changes colour to the AVEVA E3D™ colour number specified
.translucency(BOOLEAN)
No Result
Switches translucency on or off
.align()
No Result
Aligns the viewfinder frame with the 3d view direction
.lock(BOOLEAN)
No Result
Locks/unlocks the frame so it cannot be moved
.dynamic(BOOLEAN)
No Result
If true, update design will automatically occur whenever the frame is moved
.hide()
No Result
Makes the frame invisible
.show()
No Result
Makes the frame visible. Also expands the clipping planes to make sure they include the frame.
Query Methods
Name
Result
Purpose
.valid()
BOOLEAN
Is the viewfinder valid. This will be true if it was created with a valid View, otherwise false
.view()
DBREF
Returns the dbref of the associated view object
.position()
POSITION
Returns the position of the centre of the viewfinder frame.
.direction()
DIRECTION
Returns the direction of the View associated with the viewfinder
.size()
ARRAY of REAL
Returns the size of the viewfinder frame ( as Xnnn Ynnn)
.dynamic()
BOOLEAN
Returns true if in dynamic mode
1974 to current year.
AVEVA Solutions Limited and its subsidiaries. All rights reserved.
