Skip to content

GetClPenFore.md

Latest commit

 

History

History
47 lines (38 loc) · 1.12 KB

GetClPenFore.md

File metadata and controls

47 lines (38 loc) · 1.12 KB

GetClPenFore

Description

Returns the pen foreground color setting of the specified class. The color is returned as the three RGB components of the color. RGB values are in the range of 0~65535.

PROCEDURE GetClPenFore(
				className   : STRING;
				VAR colorRV : LONGINT;
				VAR colorGV : LONGINT;
				VAR colorBV : LONGINT);
def vs.GetClPenFore(className):
    return (colorRV, colorGV, colorBV)

Parameters

Name Type Description
className STRING Name of class.
colorRV LONGINT Returns RGB color component (red).
colorGV LONGINT Returns RGB color component (green).
colorBV LONGINT Returns RGB color component (blue).

Remarks

Returns the pen foreground color setting of the class named className in parameters colorRV, colorGV, and colorBV.

Examples

==== VectorScript ====

GetClPenFore('Grassy Cover',cRed,cGrn,cBlu);
RGBToColorIndex(cRed,cGrn,cBlu,colorValue);

==== Python ====

cRed,cGrn,cBlu = vs.GetClPenFore('Grassy Cover')
colorValue = vs.RGBToColorIndex(cRed,cGrn,cBlu)

Version

Availability: from VectorWorks8.0

Category

  • Classes