| ConsolidatePlanar | Object Info Vectorworks 2011 |
VectorScript Declaration:
FUNCTION ConsolidatePlanar
( obj1 :HANDLE; obj2 :HANDLE ) :BOOLEAN ; Python:
return BOOLEAN
def vs.ConsolidatePlanar(obj1, obj2): Description:
Modifies the plane of the second planar object so it is on the plane of the first object. Also moves the object so plane change doesn't affect it's position.Parameters:
obj1 Handle to the first object. obj2 Handle to the second object.
| Get2DPt | Object Info VectorWorks8.5 |
VectorScript Declaration:
PROCEDURE Get2DPt
( obj :HANDLE; index :INTEGER; VAR locX :REAL; VAR locY :REAL ) ; Python:
return loc
def vs.Get2DPt(obj, index): Description:
Returns the location of the specified vertex of a referenced object.Parameters:
obj Handle to object. index Index of vertex to be queried. loc Coordinates of 2D vertex location.
| GetBBox | Object Info MiniCAD |
VectorScript Declaration:
PROCEDURE GetBBox
( h :HANDLE; VAR p1X :REAL; VAR p1Y :REAL; VAR p2X :REAL; VAR p2Y :REAL ) ; Python:
return (p1, p2)
def vs.GetBBox(h): Description:
Procedure GetBBox returns the bounding box coordinates of the projection of the referenced object on the screen plane.
Parameters:
h Handle to object. p1 Top left coordinate of bounding box. p2 Bottom right coordinate of bounding box.
| GetObjectVariableBoolean | Object Info VectorWorks9.0 |
VectorScript Declaration:
FUNCTION GetObjectVariableBoolean
( h :HANDLE; index :INTEGER ) :BOOLEAN ; Python:
return BOOLEAN
def vs.GetObjectVariableBoolean(h, index): Description:
Returns the ON-OFF status of a Vectorworks object property.
For specific object selector index values, see the Appendix.Parameters:
h Handle to object. index Object property index. Result:
Returns a BOOLEAN value indicating the ON-OFF status of the property.Example:
castShadow:= GetObjectVariableBoolean(h,53);
| GetObjectVariableHandle | Object Info VectorWorks12.0 |
VectorScript Declaration:
FUNCTION GetObjectVariableHandle
( h :HANDLE; index :INTEGER ) :HANDLE ; Python:
return HANDLE
def vs.GetObjectVariableHandle(h, index): Description:
Returns the value of a Vectorworks object property.
| GetObjectVariableInt | Object Info VectorWorks9.0 |
VectorScript Declaration:
FUNCTION GetObjectVariableInt
( h :HANDLE; index :INTEGER ) :INTEGER ; Python:
return INTEGER
def vs.GetObjectVariableInt(h, index): Description:
Returns the value of a Vectorworks object property. Used with properties returning an INTEGER value.
For specific object selector index values, see the Appendix.
Parameters:
h Handle to object. index Object property index. Result:
Returns the value of the property as an INTEGER value.Example:
numCavities:= GetObjectVariableInt(h,199);
| GetObjectVariableLongInt | Object Info VectorWorks9.0 |
VectorScript Declaration:
FUNCTION GetObjectVariableLongInt
( h :HANDLE; index :INTEGER ) :LONGINT ; Python:
return LONGINT
def vs.GetObjectVariableLongInt(h, index): Description:
Returns the value of a Vectorworks object property. Used with properties returning a LONGINT value.
For specific object selector index values, see the Appendix.
Parameters:
h Handle to object. index Object property index. Result:
Returns the value of the property as a LONGINT value.Example:
p:= GetObjectVariableLongInt(h,579);
| GetObjectVariablePoint | Object Info Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetObjectVariablePoint
( h :HANDLE; index :INTEGER; VAR outPX :REAL; VAR outPY :REAL; VAR outPZ :REAL ) :BOOLEAN ; Python:
return (BOOLEAN, outP)
def vs.GetObjectVariablePoint(h, index): 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.Parameters:
h Handle to object. index Object property index. outP Return the object variable data point. See Also:
SetObjectVariablePoint GetObjectVariableBoolean SetObjectVariableBoolean GetObjectVariableHandle SetObjectVariableHandle GetObjectVariableInt SetObjectVariableInt GetObjectVariableLongInt SetObjectVariableLongInt GetObjectVariableReal SetObjectVariableReal GetObjectVariableString SetObjectVariableString
| GetObjectVariableReal | Object Info VectorWorks9.0 |
VectorScript Declaration:
FUNCTION GetObjectVariableReal
( h :HANDLE; index :INTEGER ) :REAL ; Python:
return REAL
def vs.GetObjectVariableReal(h, index): Description:
Returns the value of a Vectorworks object property. Used with properties returning a REAL value. Always returns values in mm, regardless of document units.
For specific object selector index values, see the Appendix.
Parameters:
h Handle to object. index Object property index. Result:
Returns the value of the property as a REAL value.Example:
dim_offset:= GetObjectVariableReal(h,4);
| GetObjectVariableString | Object Info VectorWorks9.0 |
VectorScript Declaration:
FUNCTION GetObjectVariableString
( h :HANDLE; index :INTEGER ) :STRING ; Python:
return STRING
def vs.GetObjectVariableString(h, index): Description:
Returns the value of a Vectorworks object property. Used with properties returning a STRING value.
For specific object selector index values, see the Appendix.
Parameters:
h Handle to object. index Object property index. Result:
Returns the value of the property as a STRING value.Example:
dimstdName:= GetObjectVariableString(h,27);
| GetParent | Object Info VectorWorks8.5 |
VectorScript Declaration:
FUNCTION GetParent
( h:HANDLE ) :HANDLE ; Python:
return HANDLE
def vs.GetParent(h): Description:
Returns a handle to the parent container object of the referenced object. If the object does not have a container, a handle to the objects' layer will be returned.Parameters:
h Handle to object. Result:
Returns a HANDLE to the parent object or layer.
| GetPlanarRef | Object Info Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetPlanarRef
( h:HANDLE ) :LONGINT ; Python:
return LONGINT
def vs.GetPlanarRef(h): Description:
Get the plane ref ID of the specified object.Parameters:
h Handle to the object.
| GetSymLoc | Object Info MiniCAD |
VectorScript Declaration:
PROCEDURE GetSymLoc
( symHd :HANDLE; VAR pX :REAL; VAR pY :REAL ) ; Python:
return p
def vs.GetSymLoc(symHd): Description:
Procedure GetSymLoc returns the insertion point of the referenced symbol or plug-in object.
Parameters:
symHd Handle to placed symbol. p Returns insertion point of symbol
| GetSymRot | Object Info MiniCAD |
VectorScript Declaration:
FUNCTION GetSymRot
( symHd:HANDLE ) :REAL ; Python:
return REAL
def vs.GetSymRot(symHd): Description:
Function GetSymRot returns the rotation angle (in degrees) of the referenced symbol or plug-in object.Parameters:
symHd Handle to symbol.
| GetType | Object Info MiniCAD - obsolete as of Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetType
( h:HANDLE ) :INTEGER ; Python:
return INTEGER
def vs.GetType(h): Special Notes:
GetType is obsolete as of Vectorworks 2011
Description:
Returns the type index of the referenced screen object.Parameters:
h Handle to object. See Also:
GetTypeN
| GetTypeN | Object Info Vectorworks 2011 |
VectorScript Declaration:
FUNCTION GetTypeN
( h:HANDLE ) :INTEGER ; Python:
return INTEGER
def vs.GetTypeN(h): Description:
Returns the type index of the referenced planar or screen object.
A complete listing of supported object types may be found in the Appendix.
Parameters:
h Handle to object. See Also:
GetType
| HAngle | Object Info MiniCAD |
VectorScript Declaration:
FUNCTION HAngle
( h:HANDLE ) :REAL ; Python:
return REAL
def vs.HAngle(h): Description:
Function HAngle returns the angle of the referenced line or arc object.
Parameters:
h Handle to object. Example:
PROCEDURE Example; BEGIN CallTool(-202); Message(HAngle(FSActLayer)); END; RUN(Example);
| HArea | Object Info MiniCAD - obsolete as of VectorWorks12.5 |
VectorScript Declaration:
FUNCTION HArea
( h:HANDLE ) :REAL ; Python:
return REAL
def vs.HArea(h): Special Notes:
HArea is obsolete as of VectorWorks12.5
Description:
Function HArea returns the area of the referenced object.
Parameters:
h Handle to object.
| HAreaN | Object Info Vectorworks 2012 |
VectorScript Declaration:
FUNCTION HAreaN
( ObjectHandle:HANDLE ) :REAL ; Python:
return REAL
def vs.HAreaN(ObjectHandle): Description:
Compute the area of a given object, it has the same function as HArea(), but the result in case of polyline is more accurate.Parameters:
ObjectHandle It is the object we want to calculate its area. Example:
HAreaN(object);
| HHeight | Object Info MiniCAD |
VectorScript Declaration:
FUNCTION HHeight
( h:HANDLE ) :REAL ; Python:
return REAL
def vs.HHeight(h): Description:
Function HHeight returns the height of the referenced object.
Parameters:
h Handle to object.
| HLength | Object Info MiniCAD |
VectorScript Declaration:
FUNCTION HLength
( h:HANDLE ) :REAL ; Python:
return REAL
def vs.HLength(h): Description:
Function HLength returns the length of a line.
Parameters:
h Handle to object.
| HPerim | Object Info MiniCAD |
VectorScript Declaration:
FUNCTION HPerim
( h:HANDLE ) :REAL ; Python:
return REAL
def vs.HPerim(h): Description:
Function HPerim returns the perimeter of the referenced object.
Parameters:
h Handle to object.
| HPerimN | Object Info Vectorworks 2012 |
VectorScript Declaration:
FUNCTION HPerimN
( ObjectHandle:HANDLE ) :REAL ; Python:
return REAL
def vs.HPerimN(ObjectHandle): Description:
Calculate a perimeter of an object. Same as HPerim(), but it gives more accurate result when the object is a polyline.Example:
perimeter := HPerim(object);
| HWidth | Object Info MiniCAD |
VectorScript Declaration:
FUNCTION HWidth
( h:HANDLE ) :REAL ; Python:
return REAL
def vs.HWidth(h): Description:
Function HWidth returns the width of the referenced object.
Parameters:
h Handle to object. Example:
w:=HWidth(HandleToObj);
| ObjArea | Object Info VectorWorks12.5 |
VectorScript Declaration:
FUNCTION ObjArea
( h:HANDLE ) :REAL ; Python:
return REAL
def vs.ObjArea(h): Description:
Function ObjArea returns the area of the referenced object.
Parameters:
h Handle to object.
| ObjAreaN | Object Info Vectorworks 2012 |
VectorScript Declaration:
FUNCTION ObjAreaN
( ObjectHandle :HANDLE ) :REAL ; Python:
return REAL
def vs.ObjAreaN(ObjectHandle ): Description:
HObjAreaN, this VS Call is the same as HOBJArea() call but it gives more accurate result when the object is a polyline.Example:
area := HOBJAreaN(object);
| SetAngle | Object Info Vectorworks 2009 |
VectorScript Declaration:
PROCEDURE SetAngle
( h :HANDLE; value :REAL ) ; Python:
return None
def vs.SetAngle(h, value): Description:
Set angle of the passed object.Parameters:
h Handle to object. value The new rotation angle of the object. Angle in degrees (-180;180] measured from (1,0) vector.
| SetHeight | Object Info Vectorworks 2009 |
VectorScript Declaration:
PROCEDURE SetHeight
( h :HANDLE; value :REAL ) ; Python:
return None
def vs.SetHeight(h, value): Description:
Set height of the passed object.Parameters:
h Handle to object. value The new height of the object.
| SetObjectVariableBoolean | Object Info VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE SetObjectVariableBoolean
( h :HANDLE; index :INTEGER; status :BOOLEAN ) ; Python:
return None
def vs.SetObjectVariableBoolean(h, index, status): Description:
Sets the ON-OFF status of a Vectorworks object property.
For specific object selector index values, see the Appendix.
Parameters:
h Handle to object. index Object property index. status New status for property. Example:
SetObjectVariableBoolean(17,FALSE);
| SetObjectVariableHandle | Object Info VectorWorks12.0 |
VectorScript Declaration:
PROCEDURE SetObjectVariableHandle
( h :HANDLE; index :INTEGER; value :HANDLE ) ; Python:
return None
def vs.SetObjectVariableHandle(h, index, value): Description:
Sets the value of a Vectorworks object property.
| SetObjectVariableInt | Object Info VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE SetObjectVariableInt
( h :HANDLE; index :INTEGER; value :INTEGER ) ; Python:
return None
def vs.SetObjectVariableInt(h, index, value): Description:
Sets the value of a Vectorworks object property. Used with properties requiring an INTEGER value.
For specific object selector index values, see the Appendix.Parameters:
h Handle to object. index Object property index. value New value for property. Example:
SetObjectVariableInt(h,1,2);
| SetObjectVariableLongInt | Object Info VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE SetObjectVariableLongInt
( h :HANDLE; index :INTEGER; value :LONGINT ) ; Python:
return None
def vs.SetObjectVariableLongInt(h, index, value): Description:
Sets the value of a Vectorworks object property. Used with properties requiring a LONGINT value.
For specific object selector index values, see the Appendix.
Parameters:
h Handle to object. index Object property index. value New value for property. Example:
SetPref(17,FALSE);
| SetObjectVariablePoint | Object Info Vectorworks 2011 |
VectorScript Declaration:
FUNCTION SetObjectVariablePoint
( h :HANDLE; index :INTEGER; pX :REAL; pY :REAL; pZ :REAL ) :BOOLEAN ; Python:
return BOOLEAN
def vs.SetObjectVariablePoint(h, index, p): Description:
Sets the value of a Vectorworks object property. Used with properties requiring a 2D or 3D point value.
For specific object selector index values, see the Appendix.Parameters:
h Handle to object. index Object property index. p The object variable data point. See Also:
GetObjectVariablePoint GetObjectVariableBoolean SetObjectVariableBoolean GetObjectVariableHandle SetObjectVariableHandle GetObjectVariableInt SetObjectVariableInt GetObjectVariableLongInt SetObjectVariableLongInt GetObjectVariableReal SetObjectVariableReal GetObjectVariableString SetObjectVariableString
| SetObjectVariableReal | Object Info VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE SetObjectVariableReal
( h :HANDLE; index :INTEGER; value :REAL ) ; Python:
return None
def vs.SetObjectVariableReal(h, index, value): Description:
Sets the value of a Vectorworks object property. Used with properties requiring a REAL value.
For specific object selector index values, see the Appendix.
Parameters:
h Handle to object. index Object property index. value New value for property. Example:
SetPref(17,FALSE);
| SetObjectVariableString | Object Info VectorWorks9.0 |
VectorScript Declaration:
PROCEDURE SetObjectVariableString
( h :HANDLE; index :INTEGER; value :STRING ) ; Python:
return None
def vs.SetObjectVariableString(h, index, value): Description:
Sets the value of a Vectorworks object property. Used with properties requiring a STRING value.
For specific object selector index values, see the Appendix.
Parameters:
h Handle to object. index Object property index. value New value for property. Example:
SetPref(17,FALSE);
| SetPlanarRef | Object Info Vectorworks 2011 |
VectorScript Declaration:
PROCEDURE SetPlanarRef
( h :HANDLE; refID :LONGINT ) ; Python:
return None
def vs.SetPlanarRef(h, refID): Description:
Set the plane ref ID of the specified object.Parameters:
h Handle to the object. refID Reference ID of the plane.
| SetPlanarRefIDToGround | Object Info Vectorworks 2011 |
VectorScript Declaration:
PROCEDURE SetPlanarRefIDToGround
( h:HANDLE ) ; Python:
return None
def vs.SetPlanarRefIDToGround(h): Description:
Set the specified object on the ground plane. This function is to be used inside parametric objects to place objects on the local coordinate system's ground of the parametric.Parameters:
h Handle to the object.
| SetWidth | Object Info Vectorworks 2009 |
VectorScript Declaration:
PROCEDURE SetWidth
( h :HANDLE; value :REAL ) ; Python:
return None
def vs.SetWidth(h, value): Description:
Set width of the passed object.Parameters:
h Handle to object. value The new width of the object.