Skip to content

IsPlanarObj.md

Latest commit

 

History

History
41 lines (32 loc) · 940 Bytes

IsPlanarObj.md

File metadata and controls

41 lines (32 loc) · 940 Bytes
Raw

IsPlanarObj

FUNCTION IsPlanarObj(
				object    : HANDLE;
				VAR refID : LONGINT): BOOLEAN;
def vs.IsPlanarObj(object):
    return (BOOLEAN, refID)

Parameters

Name Type Description
object HANDLE Object to test
refID LONGINT If object is planar, returns the planar refID of its plane

Remarks

This function always seems to return 0 for refID, no matter which plane the object being tested is located. Use GetPlanarRef instead to find the planar refID of a given planar object.

Examples

resultOK := IsPlanarObj(object, 1);
import vs

object = vs.FSActLayer()  # handle to the first selected object on the active layer

ok, refID = vs.IsPlanarObj(object)
vs.Message('IsPlanarObj returned: ' + str((ok, refID)))

Version

Availability: from Vectorworks 2016

Category