Skip to content

SetObjectStoryBound.md

Latest commit

 

History

History
73 lines (62 loc) · 2.15 KB

SetObjectStoryBound.md

File metadata and controls

73 lines (62 loc) · 2.15 KB
Raw

SetObjectStoryBound

Description

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

PROCEDURE SetObjectStoryBound(
				obj            : HANDLE;
				boundID        : INTEGER;
				boundType      : INTEGER;
				boundStory     : INTEGER;
				layerLevelType : STRING;
				offset         : REAL);
def vs.SetObjectStoryBound(obj, boundID, boundType, boundStory, layerLevelType, offset):
    return None

Parameters

Name Type Description
obj HANDLE The object.
boundID INTEGER The identifier of the story bound.
boundType INTEGER Bounding type: 0 - LayerZ; 1 - DefaultWallHeight; 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' = -1 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
	SetObjectStoryBound( toObject, toBoundID, boundType, boundStory, layerLevelType, tempOffset );
END ELSE
BEGIN
	SetObjectStoryBound( toObject, toBoundID, 0, 0, '', defaultReal );
END;

BEGIN
	SetObjectStoryBound( objectHand, topBoundID, boundType, boundStory, layerLevelType, topOffset );
END;
import vs

# Set 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
boundType = 0
boundStory = 2
layerLevelType = 'Design Layer-1'
offset = 0.0

vs.SetObjectStoryBound(obj, boundID, boundType, boundStory, layerLevelType, offset)

See Also

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

Version

Availability: from Vectorworks 2012

Category