Software Customisation
Reference Manual
Summary of Objects, Members and Methods
:
Object Type Details
: VIEW Gadget: VOLUME Views
VIEW Gadget: VOLUME Views
Members
Name
Type
Purpose
Background
REAL Get/Set
Get or set Background Colour Number
Background
STRING Set Only
Set Background Colour Name.
Contents
REAL ARRAY[2] Get/Set
Get or set User Contents ID.
Defcall
STRING Get/Set
Get or set default interaction callback.
Height
REAL Get Only
Get View Height.
Highlight
REAL Get/Set
Get or set Highlight Colour Number.
Highlight
STRING Set Only
Set Highlight Colour Name.
Prompt
GADGET Get/Set
Get or Set User Prompt paragraph gadget.
Subtype
STRING Get Only
Get Subtype of graphic view.
Width
REAL Get Only
Get View Width.
StatusLine
BOOLEAN Get/Set
Get or set Status Line ON (TRUE) or OFF (FALSE).
Borders
BOOLEAN Get/Set
Get or set Borders ON (TRUE) or OFF (FALSE).
Direction
REAL ARRAY[3] Get/Set
Direction vector [dE,dN,dU].
EyeMode
BOOLEAN Get/Set
TRUE for Eyemode FALSE for Modelmode.
Limits
REAL ARRAY[6] Get/Set
Limits box [E1,E2,N1,N2,U1,U2].
Mousemode
STRING Get/Set
'ZOOM', 'PAN', 'ROTATE', WALK'.
Projection
STRING Get/Set
‘PERSPECTIVE’ or ‘PARALLEL’.
Radius
REAL Get/Set
View Radius distance >0.
Range
REAL Get/Set
Range distance >0.
Refresh
NO RESULT
Refreshes the display of the gadget.
RestoreView
REAL Get/Set
Restores view saved as given view number.
SaveView
REAL Get/Set
Saves view as given view number, in the range 1 to 4.
Shaded
BOOLEAN Get/Set
TRUE for shaded FALSE for wireline.
Step
REAL Get/Set
Step size >0.
Through
REAL ARRAY[3] Get/Set
Through point [E,N,U].
WalkThrough
BOOLEAN Get/Set
TRUE for Walkthrough (equivalent to Eyemode).
LabelStyle
STRING Get/Set
Set by specifying ‘ENU’ or ‘XYZ’. Default is ‘ENU’.
Bearing
REAL Get/Set
View bearing
-180 <= bearing <=180
Elevation
REAL Get/Set
View elevation
-180 <= elevation <=180
Methods
Name
Result
Purpose
Background()
STRING
Returns the BACKGROUND colour as a name string.
Highlight()
STRING
Returns the HIGHLIGHT colour as a name string.
SetSize(REAL width, REAL height)
NO RESULT
Set view size.
RestoreView(REAL storeNumber)
NO RESULT
Restores view saved as given view number.
SaveView(REAL storeNumber)
NO RESULT
Saves view as given view number.
Command
The VIEW ... VOLUME command puts you into View Setup mode. You remain in View Setup mode until you use the EXIT command.
(VOLume)--+-- STAUTUSLINE --+-- ON --.
| ‘-- OFF -‘--------------.
+-- BORDERS --+-- ON --. |
| ‘-- OFF -‘------------------|
+-- SHADING --+-- ON --. |
| ‘-- OFF -‘------------------|
+-- <cursor> -----------------------------|
+-- LOok --+-- <dir> ---------------------.
| |-- THRough---. |
| |-- FROM -----| |
| ‘-- TOWards --+-- <pos> ----. |
| |-- <gid> ----| |
| ‘-- ID @ NL ‑-‘--|
+-- ISOmetric --+--
value
--. |
| ‘-----------‘-------------|
+-- PLAN ---------------------------------|
+-- ELEVation -- (one of N/S/E/W/X/Y) ----|
+-- CLIPping -----+-- ON --. |
| ‘-- OFF ‑‘--------------|
+-- CAPping ------+-- ON --. |
| ‘-- OFF ‑‘--------------|
+-- PERSPective --+-- ON --. |
| ‘-- OFF ‑‘--------------|
+-- WALKthrough --+-- ON --. |
| ‘-- OFF ‑‘--------------|
+--RADius ---
value
----------------------|
+--STEP -----
value
----------------------|
‘--RANGE ----
value
----------------------‘--->
Where:
<cursor> is the syntax for selecting the cursor type, as in 2-19
<border> allows control of zooming and panning as in 2-20
Note:
The StatusLine must be ON for Borders to be displayed.
Default:
StatusLine ON; Borders ON; Shading OFF.
View direction:PLAN or LOOK DOWN.
Limits: AUTO (set to current view limits).
1974 to current year.
AVEVA Solutions Limited and its subsidiaries. All rights reserved.