Skip to content

SetPenFore.md

Latest commit

 

History

History
103 lines (85 loc) · 2.96 KB

SetPenFore.md

File metadata and controls

103 lines (85 loc) · 2.96 KB
Raw

SetPenFore

Description

Procedure SetPenFore sets the pen foreground color of the referenced object. RGB values are in the range of 0~65535.

PROCEDURE SetPenFore(
				h     : HANDLE;
				color : LONGINT);
def vs.SetPenFore(h, color):
    return None

Parameters

Name Type Description
h HANDLE Handle to object.
color LONGINT RGB color value.

Remarks

(_c_ 2015.05.18): This Vectorscript routine responds to multiple types of notations:

Vectorscript:

  • Singular color index: *: colorIndex := RGBToColorIndex(65535, 0, 0); *: SetPenFore(FSActLayer, colorIndex);
  • Three RGB longints: *: SetPenFore(FSActLayer, 65535, 0, 0);

Python:

  • Singular color index: *: vs.SetPenFore(vs.FSActLayer(), vs.RGBToColorIndex(65535, 0, 0))
  • Three longints in a tuple: *: vs.SetPenFore(vs.FSActLayer(), (65535, 0, 0))
  • Three hex numbers in a tuple: *: vs.SetPenFore(vs.FSActLayer(), (0xFFFF, 0, 0))

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]. ; Warning: SetPenBack, SetPenFore will remove the "ByClass" attribute of the FILL as well. Remember to parse for it and restore it.

(Joel Sciamma 2006.08.14): To have no pen drawn, use SetLW to set the line weight to zero.

Examples

SelectandDelObjects

LineTo(pLineLength-dx,0);
SetLSN(lnewobj,2);
SetLW(lnewobj,wid);
IF GetPref(16) THEN	{black background}
	SetPenFore(lnewobj,0,0,0)
ELSE SetPenFore(lnewobj,65535,65535,65535);
IF pFlip
	THEN Arc(0.0,pLineLength/2,pLineLength,-pLineLength/2,190,160.0)
	ELSE Arc(0.0,pLineLength/2,pLineLength,-pLineLength/2,170,-160.0);

SetRField(hobj,kRecName,kStatName,StatVal);
WHILE (hobj <> NIL) DO BEGIN
	SetPenFore(hobj,r,g,b);
	hobj := NextObj(hobj);
	END;

BEGIN
	FPenFore (R, G, B);
	SetPenFore (objectH, R, G, B);
END;
else:
	colorR, colorG, colorB = vs.GetPenFore( gObjHandle )
	vs.SetPenFore( hTmpHand, ( colorR, colorG, colorB )	)

vs.CreateText( message1 )
vs.SetTextVerticalAlign( vs.LNewObj(), 3 )
vs.SetTextJust( vs.LNewObj(), 2 )
vs.SetPenFore( vs.LNewObj(), 65535, 0, 0 )
vs.SetFPat( vs.LNewObj(), 0 )
b1, b2 = vs.GetBBox( vs.LNewObj() )
vs.Rect( kBf * b1[0], kBf * b1[1], kBf * b2[0], kBf * b2[1] )
vs.SetPenFore( vs.LNewObj(), 65535, 0, 0 )

vs.SetFillBack(objH, vs.GetFillBack(parentH))
vs.SetFillFore(objH, vs.GetFillFore(parentH))
vs.SetPenBack(objH, vs.GetPenBack(parentH))
vs.SetPenFore(objH, vs.GetPenFore(parentH))
start, end, style, size	= vs.GetMarker(parentH)
vs.SetMarker(objH, start, end, style, size)
vs.SetOpacity(objH, vs.GetOpacity(parentH))

See Also

VS Functions: RGBToColorIndex | ColorIndexToRGB

Version

Availability: from All Versions

Category