Difference between revisions of "VS:PenFore"

From Vectorworks Developer
Jump to: navigation, search
m (1 revision)
(add remark about multiple access)
Line 31: Line 31:
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<remark>
 
<remark>
 +
[[User:Orso.b.schmid| Orso]]: This Procedure will also accept a single INTEGER Color Palette Index value in lieu of three LONGINT RGB values for the COLOR parameter. The Color index can be obtained with [[VS:RGBToColorIndex]]. See remarks under [[VS:SetPenFore]] for more infos. On Vectorlab there is a list of all color routines accepting multiple variable type, see: [http://www.vectorlab.info/index.php?title=Index_pitfalls#Colors Color Index].
 +
 
When using this command, you should check for the black background preference setting if you're trying to draw black lines.
 
When using this command, you should check for the black background preference setting if you're trying to draw black lines.
 
</remark>
 
</remark>
Line 36: Line 38:
 
-----------------------------------------------------------------------------------------------------------
 
-----------------------------------------------------------------------------------------------------------
 
<sample>
 
<sample>
 +
 
==== VectorScript ====
 
==== VectorScript ====
 
<code lang="pas">
 
<code lang="pas">
PenFore(65535,0,39321);
+
colorIndex := RGBToColorIndex(65535, 0, 0);
 +
PenFore(colorIndex); { alternative: using a color index }
 +
PenFore(65535, 0, 39321); { alternative: using an RGB triplet }
 
</code>
 
</code>
 +
 
==== Python ====
 
==== Python ====
 
<code lang="py">
 
<code lang="py">
 
+
vs.PenFore((65535, 0, 39321))
 
</code>
 
</code>
 
</sample>
 
</sample>

Revision as of 00:43, 19 May 2015

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Procedure PenFore sets the active pen foreground color for the document. RGB values are in the range of 0~65535.
PROCEDURE PenFore(
color  :LONGINT);
def vs.PenFore(color):
    return None

Parameters

color LONGINT RGB color value to be set as active pen foreground.

Remarks

Orso: This Procedure will also accept a single INTEGER Color Palette Index value in lieu of three LONGINT RGB values for the COLOR parameter. The Color index can be obtained with VS:RGBToColorIndex. See remarks under VS:SetPenFore for more infos. On Vectorlab there is a list of all color routines accepting multiple variable type, see: Color Index.

When using this command, you should check for the black background preference setting if you're trying to draw black lines.

Example

VectorScript

colorIndex := RGBToColorIndex(65535, 0, 0);
PenFore(colorIndex); { alternative: using a color index }
PenFore(65535, 0, 39321); { alternative: using an RGB triplet }

Python

vs.PenFore((65535, 0, 39321))

Version

Availability: from All Versions

See Also

VS Functions:

VS:RGBToColorIndex | VS:ColorIndexToRGB

VS Functions:

[[VS:RGBToColorIndex]]

| [[VS:ColorIndexToRGB]]
Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox