Skip to content

ConsolidatePlanar.md

Latest commit

 

History

History
46 lines (37 loc) · 1.06 KB

ConsolidatePlanar.md

File metadata and controls

46 lines (37 loc) · 1.06 KB
Raw

ConsolidatePlanar

Description

Modifies the plane of the second planar object so it is on the plane of the first object. Also moves the object so plane change doesn't affect it's position.

FUNCTION ConsolidatePlanar(
				obj1 : HANDLE;
				obj2 : HANDLE): BOOLEAN;
def vs.ConsolidatePlanar(obj1, obj2):
    return BOOLEAN

Parameters

Name Type Description
obj1 HANDLE Handle to the first object.
obj2 HANDLE Handle to the second object.

Examples

resultOK := ConsolidatePlanar(obj1, obj2);
import vs

# Modifies the plane of the second planar object so it is on the plane of the
# first object.
obj1 = vs.FSActLayer()  # handle to the first selected object on the active layer
obj2 = vs.NextSObj(vs.FSActLayer())  # handle to the next selected object

ok = vs.ConsolidatePlanar(obj1, obj2)
if ok:
    vs.Message('ConsolidatePlanar succeeded')
else:
    vs.Message('ConsolidatePlanar failed')

Version

Availability: from Vectorworks 2011

Category