Skip to content

GetObjectVariablePoint.md

Latest commit

 

History

History
65 lines (54 loc) · 1.91 KB

GetObjectVariablePoint.md

File metadata and controls

65 lines (54 loc) · 1.91 KB
Raw

GetObjectVariablePoint

Description

Returns the value of a Vectorworks object property. Used with properties returning a 2D or 3D point value.

For specific object selector index values, see the Appendix.

FUNCTION GetObjectVariablePoint(
				h                       : HANDLE;
				index                   : INTEGER;
				VAR outPx, outPy, outPz : REAL): BOOLEAN;
def vs.GetObjectVariablePoint(h, index):
    return (BOOLEAN, outP)

Parameters

Name Type Description
h HANDLE Handle to object.
index INTEGER Object property index.
outP REAL Return the object variable data point.

Remarks

In python scripting, the point 'outP' will be returned as tuple (x,y,z)

Examples

resultOK := GetObjectVariablePoint(h, 1, 1.0, 2.0, 0.5);
import vs

# Returns the value of a Vectorworks object property.
h = vs.FSActLayer()  # handle to the first selected object on the active layer
index = 1

ok, outP = vs.GetObjectVariablePoint(h, index)
vs.Message('GetObjectVariablePoint returned: ' + str((ok, outP)))

See Also

VS Functions: SetObjectVariablePoint | GetObjectVariableBoolean | SetObjectVariableBoolean | GetObjectVariableHandle | SetObjectVariableHandle | GetObjectVariableInt | SetObjectVariableInt | GetObjectVariableLongInt | SetObjectVariableLongInt | GetObjectVariableReal | SetObjectVariableReal | GetObjectVariableString | SetObjectVariableString

Version

Availability: from Vectorworks 2011

Category