ActLayer | Layers |
Declaration:
FUNCTION ActLayer
:HANDLE ; Description:
Function ActLayer returns a handle to the currently active layer in a document.See Also:
ActiveClass ActSymDef
CopyMode | Layers |
Declaration:
PROCEDURE CopyMode
( mode:INTEGER ) ; Description:
Procedure CopyMode sets the transfer mode for the active layer.
Transfer Modes
Transfer Mode Index Value Copy 8 OR 9 XOR 10 BIC 11 Inverse Copy 12 Inverse OR 13 Inverse XOR 14 Inverse BIC 15
Parameters:
mode Mode index value.
FLayer | Layers |
Declaration:
FUNCTION FLayer
:HANDLE ; Description:
Function FLayer returns a handle to the first layer in a VectorWorks document.
GetLayer | Layers |
Declaration:
FUNCTION GetLayer
( h:HANDLE ) :HANDLE ; Description:
Function GetLayer returns a handle to the layer of the referenced object.
Parameters:
h Handle to object. Example:
LayerHandle:=GetLayer(ObjHd);
GetLName | Layers |
Declaration:
FUNCTION GetLName
( h:HANDLE ) :STRING ; Description:
Function GetLName returns the name of the referenced layer.Parameters:
h Handle to layer.
GetLScale | Layers |
Declaration:
FUNCTION GetLScale
( h:HANDLE ) :REAL ; Description:
Function GetLScale returns the scale of the referenced layer.
Parameters:
h Handle to layer. Example:
GetLVis | Layers |
Declaration:
FUNCTION GetLVis
( h:HANDLE ) :INTEGER ; Description:
Function GetLVis returns the visibility of the referenced layer.
Table - Layer Visibility
Visibility Index Value Normal 0 Grayed 1 Invisible 2
Parameters:
h Handle to layer. Example:
VisStatus:=GetLVis(HandleToLayer);
GetZVals | Layers |
Declaration:
PROCEDURE GetZVals
( VAR zVal :REAL; VAR deltaZVal :REAL ) ; Description:
Procedure GetZVals returns the Z (layer base elevation) and delta Z (layer thickness) values for the active layer.Parameters:
zVal Layer base elevation(above document ground plane). deltaZVal Layer thickness.
GrayLayer | Layers |
Declaration:
PROCEDURE GrayLayer
; Description:
Procedure GrayLayer sets the visibility status of the active layer to grayed. Objects on grayed layers will always appear grayed when viewed from other layers.
Example:
Layer('Future Construction'); GrayLayer; {grays the layer 'Future Construction'}
HideLayer | Layers |
Declaration:
PROCEDURE HideLayer
; Description:
Procedure HideLayer sets the visibility status of the active layer to hidden. Objects on hidden layers will not be viewable from other layers.
Example:
Layer('Future Construction'); HideLayer; {hides the layer 'Future Construction'}
Layer | Layers |
Declaration:
PROCEDURE Layer
( name:STRING ) ; Description:
Procedure Layer creates a new layer in a VectorWorks document. After creation, the new layer becomes the active layer of the document.
Layer can also be used to switch the active layer of the document. If the layer name passed to the procedure already exists, the procedure switches the active layer to the specified layer.
Single quotes should be avoided in layer names, as they will be treated as a mismatched string specifier, and will cause an error to be generated.
Parameters:
name Name of new or existing layer. Example:
Layer('Ductwork-1st Floor'); {creates a new layer named 'Ductwork-1st Floor'} Layer(newLayerName); {creates a new layer whose name is specified in the variable} Layer('Untitled-1'); {switches to the existing layer 'Untitled-1'}
LayerRef | Layers |
Declaration:
PROCEDURE LayerRef
( layerName:STRING ) ; Description:
Procedure LayerRef places a layer reference(layer link) into the active layer at location (0,0).
Parameters:
layerName Name of referenced layer. Example:
LayerRef('Layer-2'); {creates a layer link of 'Layer-2' on the active layer}
LFillBack | Layers |
Declaration:
PROCEDURE LFillBack
( colorR :LONGINT; colorG :LONGINT; colorB :LONGINT ) ; Description:
Procedure LFillBack sets the background fill color for the active layer.
Parameters:
color RGB color component value. Example:
LFillBack(65535,0,39321);
LFillFore | Layers |
Declaration:
PROCEDURE LFillFore
( colorR :LONGINT; colorG :LONGINT; colorB :LONGINT ) ; Description:
Procedure LFillFore sets the foreground fill color for the active layer.Parameters:
color RGB color component value. Example:
LFillFore(65535,0,39321);
LLayer | Layers |
Declaration:
FUNCTION LLayer
:HANDLE ; Description:
Function LLayer returns a handle to the last layer in a VectorWorks document.
LPenBack | Layers |
Declaration:
PROCEDURE LPenBack
( colorR :LONGINT; colorG :LONGINT; colorB :LONGINT ) ; Description:
Procedure LPenBack sets the background pen color for the active layer.Parameters:
color RGB color component value. Example:
LPenFore | Layers |
Declaration:
PROCEDURE LPenFore
( colorR :LONGINT; colorG :LONGINT; colorB :LONGINT ) ; Description:
Procedure LPenFore sets the foreground pen color for the active layer.Parameters:
color RGB color component value. Example:
NumLayers | Layers |
Declaration:
FUNCTION NumLayers
:INTEGER ; Description:
Function NumLayers returns the current number of layers within the active document.
NumObj | Layers |
Declaration:
FUNCTION NumObj
( h:HANDLE ) :INTEGER ; Description:
Function NumObj returns the number of objects on the referenced layer.
Parameters:
h Handle to layer.
SetLScale | Layers |
Declaration:
PROCEDURE SetLScale
( h :HANDLE; scale :REAL ) ; Description:
Procedure SetLScale sets the scale of the referenced layer.
Calculating the ScaleTo calculate the scale parameter from an architecural scale, the following formula may be used :
denominator/numerator * true size(in inches) = ActualSize For example, to calculate a scale of 3/8"=1'-0", the scale parameter would be 8/3 *12 = 32.
Parameters:
h Handle to layer. scale Scale value for layer. Example:
SetLScale(HandleToLayer,96); {sets the referenced layer to a scale of 1/8" = 1'}
SetScale | Layers |
Declaration:
PROCEDURE SetScale
( actualSize:REAL ) ; Description:
Procedure SetScale sets the drawing scale of the active layer of the document.
Calculating the ScaleTo calculate the scale parameter from an architecural scale, the following formula may be used :
denominator/numerator * true size(in inches) = ActualSize For example, to calculate a scale of 3/8"=1'-0", the scale parameter would be 8/3 *12 = 32.
Parameters:
actualSize Drawing scale factor.
SetZVals | Layers |
Declaration:
PROCEDURE SetZVals
( zDistance :REAL; deltaZDistance :REAL ) ; Description:
Procedure SetZVals sets the Z (layer base elevation) and delta Z (layer thickness) for the active layer.Parameters:
zDistance Layer base elevation(above document ground plane). deltaZDistance Layer thickness.
ShowLayer | Layers |
Declaration:
PROCEDURE ShowLayer
; Description:
Procedure ShowLayer sets the visibility status of the active layer to visible. Newly created layers always defaulted to the Show mode.
Example:
Layer('Future Construction'); ShowLayer;