VS:GetObjectVariablePoint

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

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

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)

Version

Availability: from Vectorworks 2011

See Also

VS Functions:

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

VS Functions:

[[VS:SetObjectVariablePoint]] | [[VS:GetObjectVariableBoolean]] | [[VS:SetObjectVariableBoolean]] | [[VS:GetObjectVariableHandle]] | [[VS:SetObjectVariableHandle]] | [[VS:GetObjectVariableInt]] | [[VS:SetObjectVariableInt]] | [[VS:GetObjectVariableLongInt]] | [[VS:SetObjectVariableLongInt]] | [[VS:GetObjectVariableReal]] | [[VS:SetObjectVariableReal]] | [[VS:GetObjectVariableString]]

| [[VS:SetObjectVariableString]]