VS:Centroid: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
m (1 revision)
 
m (1 revision)
(No difference)

Revision as of 14:25, 12 August 2013

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

Description

Returns the centroid of the object. Returns false if an unsupported object type is supplied.

FUNCTION Centroid(
h :HANDLE;
VAR x :REAL;
VAR y :REAL) :BOOLEAN;
def vs.Centroid(h):
    return (BOOLEAN, x, y)

Parameters

h HANDLE
x REAL Output parameter.
y REAL Output parameter.

Example

PROCEDURE Example;
VAR
   h :HANDLE;
   x, y :REAL;
BEGIN
   h := FSActLayer;
   IF Centroid(h, x, y) THEN BEGIN
      x := x / (25.4 / GetPrefReal(152));
      y := y / (25.4 / GetPrefReal(152));
      Locus(x, y);
   END;
END;
RUN(Example);

Version

Availability: from All Versions

This is drop-in function.