Object Info

Declaration:

PROCEDURE Get2DPt

( obj :HANDLE;

index :INTEGER;

VAR locX :REAL;

VAR locY :REAL

) ;

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

Declaration:

PROCEDURE GetBBox

( h :HANDLE;

VAR p1X :REAL;

VAR p1Y :REAL;

VAR p2X :REAL;

VAR p2Y :REAL

) ;

Description:

Procedure GetBBox returns the bounding box coordinates of the referenced object.

Parameters:

h Handle to object.

p1 Top left coordinate of bounding box.

p2 Bottom right coordinate of bounding box.

GetObjectVariableBoolean

Object Info

Declaration:

FUNCTION GetObjectVariableBoolean

( h :HANDLE;

index :INTEGER

) :BOOLEAN ;

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

Declaration:

FUNCTION GetObjectVariableHandle

( h :HANDLE;

index :INTEGER

) :HANDLE ;

Description:

Returns the value of a Vectorworks object property.

GetObjectVariableInt

Object Info

Declaration:

FUNCTION GetObjectVariableInt

( h :HANDLE;

index :INTEGER

) :INTEGER ;

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

Declaration:

FUNCTION GetObjectVariableLongInt

( h :HANDLE;

index :INTEGER

) :LONGINT ;

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);

GetObjectVariableReal

Object Info

Declaration:

FUNCTION GetObjectVariableReal

( h :HANDLE;

index :INTEGER

) :REAL ;

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

Declaration:

FUNCTION GetObjectVariableString

( h :HANDLE;

index :INTEGER

) :STRING ;

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

Declaration:

FUNCTION GetParent

( h:HANDLE ) :HANDLE ;

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.

GetSymLoc

Object Info

Declaration:

PROCEDURE GetSymLoc

( symHd :HANDLE;

VAR pX :REAL;

VAR pY :REAL

) ;

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

Declaration:

FUNCTION GetSymRot

( symHd:HANDLE ) :REAL ;

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

Declaration:

FUNCTION GetType

( h:HANDLE ) :INTEGER ;

Description:

Returns the type index of the referenced object.

A complete listing of supported object types may be found in the Appendix.

Parameters:

h Handle to object.

HAngle

Object Info

Declaration:

FUNCTION HAngle

( h:HANDLE ) :REAL ;

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

Declaration:

FUNCTION HArea

( h:HANDLE ) :REAL ;

Special Notes:

HArea is obsolete as of VectorWorks12.5

Description:

Function HArea returns the area of the referenced object.

Parameters:

h Handle to object.

HHeight

Object Info

Declaration:

FUNCTION HHeight

( h:HANDLE ) :REAL ;

Description:

Function HHeight returns the height of the referenced object.

Parameters:

h Handle to object.

HLength

Object Info

Declaration:

FUNCTION HLength

( h:HANDLE ) :REAL ;

Description:

Function HLength returns the length of a line.

Parameters:

h Handle to object.

HPerim

Object Info

Declaration:

FUNCTION HPerim

( h:HANDLE ) :REAL ;

Description:

Function HPerim returns the perimeter of the referenced object.

Parameters:

h Handle to object.

HWidth

Object Info

Declaration:

FUNCTION HWidth

( h:HANDLE ) :REAL ;

Description:

Function HWidth returns the width of the referenced object.

Parameters:

h Handle to object.

Example:
w:=HWidth(HandleToObj); 

ObjArea

Object Info

Declaration:

FUNCTION ObjArea

( h:HANDLE ) :REAL ;

Description:

Function ObjArea returns the area of the referenced object.

Parameters:

h Handle to object.

SetAngle

Object Info

Declaration:

PROCEDURE SetAngle

( h :HANDLE;

value :REAL

) ;

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

Declaration:

PROCEDURE SetHeight

( h :HANDLE;

value :REAL

) ;

Description:

Set height of the passed object.

Parameters:

h Handle to object.

value The new height of the object.

SetObjectVariableBoolean

Object Info

Declaration:

PROCEDURE SetObjectVariableBoolean

( h :HANDLE;

index :INTEGER;

status :BOOLEAN

) ;

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

Declaration:

PROCEDURE SetObjectVariableHandle

( h :HANDLE;

index :INTEGER;

value :HANDLE

) ;

Description:

Sets the value of a Vectorworks object property.

SetObjectVariableInt

Object Info

Declaration:

PROCEDURE SetObjectVariableInt

( h :HANDLE;

index :INTEGER;

value :INTEGER

) ;

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

Declaration:

PROCEDURE SetObjectVariableLongInt

( h :HANDLE;

index :INTEGER;

value :LONGINT

) ;

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);

SetObjectVariableReal

Object Info

Declaration:

PROCEDURE SetObjectVariableReal

( h :HANDLE;

index :INTEGER;

value :REAL

) ;

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

Declaration:

PROCEDURE SetObjectVariableString

( h :HANDLE;

index :INTEGER;

value :STRING

) ;

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);

SetWidth

Object Info

Declaration:

PROCEDURE SetWidth

( h :HANDLE;

value :REAL

) ;

Description:

Set width of the passed object.

Parameters:

h Handle to object.

value The new width of the object.

obj	Handle to object.
index	Index of vertex to be queried.
loc	Coordinates of 2D vertex location.

h	Handle to object.
p1	Top left coordinate of bounding box.
p2	Bottom right coordinate of bounding box.

symHd	Handle to placed symbol.
p	Returns insertion point of symbol

h	Handle to object.
value	The new rotation angle of the object. Angle in degrees (-180;180] measured from (1,0) vector.

h	Handle to object.
index	Object property index.
status	New status for property.