Skip to content

GetObjBoundElevation.md

Latest commit

 

History

History
62 lines (50 loc) · 1.58 KB

GetObjBoundElevation.md

File metadata and controls

62 lines (50 loc) · 1.58 KB
Raw

GetObjBoundElevation

Description

Get the elevation of the specified bound ID relative to the object's layer.

FUNCTION GetObjBoundElevation(
				obj     : HANDLE;
				boundID : INTEGER): REAL;
def vs.GetObjBoundElevation(obj, boundID):
    return REAL

Parameters

Name Type Description
obj HANDLE The object.
boundID INTEGER The identifier of the story bound.

Remarks

Peter Vandewalle: the result is in mm.

Examples

BEGIN
	topHeigh    := GetObjBoundElevation( gPluginH, topBoundID  );
	botHeight   := GetObjBoundElevation( gPluginH, bottomBoundID );

{ get object's Z bounds. }
topHeight      := GetObjBoundElevation( parmHand, kTopBoundID  );
bottomHeight   := GetObjBoundElevation( parmHand, kBottomBoundID );
import vs

# Get the elevation of the specified bound ID relative to the object's layer.
obj = vs.FSActLayer()  # handle to the first selected object on the active layer
boundID = 1

value = vs.GetObjBoundElevation(obj, boundID)
vs.Message('GetObjBoundElevation returned: ' + str(value))

See Also

VS Functions: HasObjStoryBounds | HasObjStoryBound | GetObjStoryBound | SetObjectStoryBound | DelObjStoryBounds | DelObjStoryBound | GetObjStoryBoundsCnt | GetObjStoryBoundsAt

Version

Availability: from Vectorworks 2012

Category