Skip to content

SetPlanarRef.md

Latest commit

 

History

History
66 lines (53 loc) · 1.81 KB

SetPlanarRef.md

File metadata and controls

66 lines (53 loc) · 1.81 KB
Raw

SetPlanarRef

Description

Set the plane ref ID of the specified object.

PROCEDURE SetPlanarRef(
				h     : HANDLE;
				refID : LONGINT);
def vs.SetPlanarRef(h, refID):
    return None

Parameters

Name Type Description
h HANDLE Handle to the object.
refID LONGINT Reference ID of the plane.

Remarks

The refID is the return value from GetPlanarRef(). As noted in GetCurrentPlanarRefID(). Screen Plane has a ref ID of 0. Layer Plane has a ref ID of -1.

[[User:Rgm|Rgm]] [2012.05.16]: Seems to be equivalent to SetObjectVariableBoolean(hd, 1160, TRUE);

In VW2011, this will silently fail to set an object to Screen Plane unless the object's Z is the negative of the Layer Z of the design layer the object exists on.

For example, if GetZVals(zVal, deltaZVal) gives a non-zero zVal, you'll have to call Move3DObj(hd, 0, 0, -zVal) before SetPlanarRef(hd,0) will have any effect.

Examples

	SetClass( gParmH, gClassN );
	{ When creating the object, SetClass regenerates it in Screen Plane.
		TO fix this we will SET it in the same plane with the gLine }
	planarRef := GetPlanarRef( gLine );
	SetPlanarRef( gParmH, planarRef );
END

BEGIN
	SetPlanarRef( h, 0 );
	result := SetTextAdorner(TextHand,h,TextLocX,TextLocY);
	IF GetPref(16) THEN
		BEGIN
		WhiteR := 0;

BEGIN
	SetPlanarRef(pathTemplate, -1);{Do not look for logic here, it just works}
	HRotate(pathTemplate, 0, 0, 0);{Do not look for logic here, it just works}
planarRef = vs.GetPlanarRef( hDuplicated )
vs.SetPlanarRef( hDuplicated, 0 )
vs.HScale2D( hDuplicated, 0, 0, dMarkerScale, dMarkerScale, True)
vs.SetPlanarRef( hDuplicated, planarRef )

Version

Availability: from Vectorworks 2011

Category