Skip to content

GetObjStoryBound.md

Latest commit

 

History

History
78 lines (66 loc) · 2.63 KB

GetObjStoryBound.md

File metadata and controls

78 lines (66 loc) · 2.63 KB
Raw

GetObjStoryBound

Description

Get the data of the specified story bound of this object.

FUNCTION GetObjStoryBound(
				obj                : HANDLE;
				boundID            : INTEGER;
				VAR boundType      : INTEGER;
				VAR boundStory     : INTEGER;
				VAR layerLevelType : STRING;
				VAR offset         : REAL): BOOLEAN;
def vs.GetObjStoryBound(obj, boundID):
    return (BOOLEAN, boundType, boundStory, layerLevelType, offset)

Parameters

Name Type Description
obj HANDLE The object.
boundID INTEGER The identifier of the story bound.
boundType INTEGER Bounding type: 0 - DefaultWallHeight; 1 - LayerZ; 2 - Story
boundStory INTEGER The story identified by 'boundType' = (2 - Story). If 'boundStory' = 0 then it is this story (the object's story); If 'boundStory' = 1 then it is the story above; If 'boundStory' = 2 then it is the story below.
layerLevelType STRING The layer type which defines this bound
offset REAL The offset distance from the specified bound story

Examples

BEGIN
	IF GetObjStoryBound( fromObject, formBoundID, boundType, boundStory, layerLevelType, tempOffset ) THEN
	BEGIN
		SetObjectStoryBound( toObject, toBoundID, boundType, boundStory, layerLevelType, tempOffset );
	END ELSE
	BEGIN
		SetObjectStoryBound( toObject, toBoundID, 0, 0, '', defaultReal );
	END;

BEGIN
	formatHand := GetObject( objectName );
	IF GetObjStoryBound( formatHand, topBoundID, boundType, boundStory, layerLevelType, topOffset ) &
		( NOT HasObjStoryBound( objectHand, topBoundID ) ) THEN
	BEGIN
		SetObjectStoryBound( objectHand, topBoundID, boundType, boundStory, layerLevelType, topOffset );
	END;

doesExist          := GetObjStoryBound( objectHand, boundID, boundType, boundStory, layerLevelType, tempOffset );
import vs

# Get the data of the specified story bound of this object.
obj = vs.FSActLayer()  # handle to the first selected object on the active layer
boundID = 1

ok, boundType, boundStory, layerLevelType, offset = vs.GetObjStoryBound(obj, boundID)
vs.Message('GetObjStoryBound returned: ' + str((ok, boundType, boundStory, layerLevelType, offset)))

See Also

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

Version

Availability: from Vectorworks 2012

Category