Angle Criteria 
MiniCAD

VectorScript Declaration:

FUNCTION   Angle
( c:CRITERIA ) :REAL ;

Python:

def  vs.Angle(c):
   return REAL

Description:

Returns the angle value of a line segment or an arc. If more than one line segment or arc matches the search criteria, the function will return the sum of the matching objects' angle values.

Parameters:

c Search criteria.

Result:

If an object matches the search criteria but is not a line segment or an arc, the value 0(zero) is returned.

Example:

aValue:=Angle(N='LineSeg');



  Area Criteria 
MiniCAD - obsolete as of VectorWorks12.5

VectorScript Declaration:

FUNCTION   Area
( c:CRITERIA ) :REAL ;

Python:

def  vs.Area(c):
   return REAL

Special Notes:

Area is obsolete as of VectorWorks12.5

Description:

Returns the area of an object. If more than one object matches the search criteria, the function will return the sum of all the matching object areas.

Parameters:

c Search criteria.

Example:

totalA:=Area((C='Plywood')and(L='First'));
{returns the area of all objects in class 'Plywood' on layer 'First'}



  AreaN Criteria 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   AreaN
( c:CRITERIA ) :REAL ;

Python:

def  vs.AreaN(c):
   return REAL

Description:

Returns the area of an object. If more than one object matches the search criteria, the function will return the sum of all the matching object areas.

Parameters:

c Search criteria.

Example:

totalA:=AreaN((C='Plywood'));
{returns the area of all objects in class 'Plywood'}



  BotBound Criteria 
MiniCAD - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   BotBound
( c:CRITERIA ) :REAL ;

Python:

def  vs.BotBound(c):
   return REAL

Special Notes:

BotBound is obsolete as of Vectorworks 2012

Description:

Returns the y-coordinate of the bounding box (bottom right corner) of an object matching the search criteria. If more than one object matches the search criteria, the function will return the bottom value of the last matching object found.

Parameters:

c Search criteria.

Example:

BotBValue:=BotBound(N='MyRect');



  BotBoundN Criteria 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   BotBoundN
( c:CRITERIA ) :REAL ;

Python:

def  vs.BotBoundN(c):
   return REAL

Description:

Returns the y-coordinate of the bounding box (bottom right corner) of an object matching the search criteria. If more than one object matches the search criteria, the function will return the value of the coordinate of the bottommost matching object found.

Parameters:

c Search criteria.

Example:

BotBValue:=BotBoundN(N='MyRect');



  ComponentArea Criteria 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   ComponentArea
(   c :CRITERIA;
    index :INTEGER
) :REAL ;

Python:

def  vs.ComponentArea(c, index):
   return REAL

Description:

Returns the area of one side the specified component, minus any holes in the 3D object.

Parameters:

c The search criteria string
index The index of the component.



  ComponentVolume Criteria 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   ComponentVolume
(   c :CRITERIA;
    index :INTEGER
) :REAL ;

Python:

def  vs.ComponentVolume(c, index):
   return REAL

Description:

Returns the 3D volume of the specified component, minus any holes in the 3D object.

Parameters:

c The search criteria string.
index The index of the component.



  Count Criteria 
MiniCAD

VectorScript Declaration:

FUNCTION   Count
( c:CRITERIA ) :LONGINT ;

Python:

def  vs.Count(c):
   return LONGINT

Description:

Counts all of the objects which match the search criteria.

Parameters:

c Search criteria.

Example:

CountValue := Count((FP=4)and(T='Rect'));
{counts all rectangles with a fillpat index of 4}



  CriteriaArea Criteria 
VectorWorks12.0 - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   CriteriaArea
( c:CRITERIA ) :REAL ;

Python:

def  vs.CriteriaArea(c):
   return REAL

Special Notes:

CriteriaArea is obsolete as of Vectorworks 2012

Description:

Returns the area of an object. If more than one object matches the search criteria, the function will return the sum of all the matching object areas.

Parameters:

c Search criteria.

Example:

totalA:=Area((C='Plywood')and(L='First'));
{returns the area of all objects in class 'Plywood' on layer 'First'}



  CriteriaSurfaceArea Criteria 
VectorWorks12.0 - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   CriteriaSurfaceArea
( c:CRITERIA ) :REAL ;

Python:

def  vs.CriteriaSurfaceArea(c):
   return REAL

Special Notes:

CriteriaSurfaceArea is obsolete as of Vectorworks 2012

Description:

Returns the surface area of the items matching the specified criteria. If more than one object matches the search criteria, the sum of all the surface areas of the matching objects will be returned.

CriteriaSurfaceArea will return only return areas on objects which support the solids modelling functions.

Parameters:

c Search criteria.

Example:

totalArea:=CriteriaSurfaceArea((C='Empty Space'));



  CriteriaVolume Criteria 
VectorWorks12.0 - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   CriteriaVolume
( c:CRITERIA ) :REAL ;

Python:

def  vs.CriteriaVolume(c):
   return REAL

Special Notes:

CriteriaVolume is obsolete as of Vectorworks 2012

Description:

Returns the volume of the items matching the specified criteria. If more than one object matches the search criteria, the sum of all the volumes of the matching objects will be returned.

CriteriaVolume will return only return volumes on objects which support the solids modelling functions.

Parameters:

c Search criteria.

Example:

totalVol:=CriteriaVolume((C='Empty Space'));



  DSelectObj Criteria 
MiniCAD

VectorScript Declaration:

PROCEDURE   DSelectObj
( c:CRITERIA ) ;

Python:

def  vs.DSelectObj(c):
   return None

Description:

Deselects all objects which match the search criteria.

Parameters:

c Search criteria.

Example:

DSelectObj(S='Pine Tree');
{deselects all 'Pine Tree' symbols}



  EditProperties Criteria 
VectorWorks12.5

VectorScript Declaration:

PROCEDURE   EditProperties
( c:CRITERIA ) ;

Python:

def  vs.EditProperties(c):
   return None

Description:

Displays the 'Properties' dialog for all objects matching the specified search criteria

Parameters:

c Search criteria.



  Eval Criteria 
MiniCAD

VectorScript Declaration:

FUNCTION   Eval
(   h :HANDLE;
    c :CRITERIA
) :REAL ;

Python:

def  vs.Eval(h, c):
   return REAL

Description:

Evaluates whether an object meets the specified search criteria.

When used with record criteria, it will determine whether a specific record is attached to the object; if used with record-field criteria, it will return the value of the field as a REAL value.


Parameters:

h Handle of object to which the search criteria will be applied.
c Search criteria.

Result:

If the criteria is a record-field criteria, the procedure will return the value contained within the field. All other criteria return the TRUE-FALSE state of the criteria condition.

Example:

hasRecord:=Eval(handleToObject,(R IN ['Part Info']);



  EvalStr Criteria 
MiniCAD

VectorScript Declaration:

FUNCTION   EvalStr
(   h :HANDLE;
    c :CRITERIA
) :STRING ;

Python:

def  vs.EvalStr(h, c):
   return STRING

Description:

Evaluates whether an object meets the specified search criteria.

When used with record criteria, it will determine whether a specific record is attached to the object; if used with record-field criteria, it will return the value of the field as a STRING.

Parameters:

h Handle of object to which the search criteria will be applied.
c Search criteria.

Result:

If the criteria is a record-field criteria, the procedure will return the value contained within the field. All other criteria return the TRUE-FALSE state of the criteria condition.

Example:

dataValue:= EvalStr(handleToObject,('Part Info'.'Serial No.'));



  ForEachObject Criteria 
MiniCAD

VectorScript Declaration:

PROCEDURE   ForEachObject
(   callback :PROCEDURE;
    c :CRITERIA
) ;

Python:

def  vs.ForEachObject(callback, c):
   return None

Description:

Calls a user defined procedure to operate on each object matching the specified search criteria.

The procedure subroutine specified by the callback parameter must have one parameter of type HANDLE, which is passed the handle to an object by the ForEachObject call.

Parameters:

callback Name of action procedure to be applied to matching objects
c Search criteria for locating objects.

Example:

PROCEDURE PickRect;

PROCEDURE SelectThem(h :HANDLE);
BEGIN
	SetSelect(h);
END;

BEGIN
	ForEachObject(SelectThem, T=RECT);
END;
RUN(PickRect);



  Height Criteria 
MiniCAD

VectorScript Declaration:

FUNCTION   Height
( c:CRITERIA ) :REAL ;

Python:

def  vs.Height(c):
   return REAL

Description:

Returns the height of an object. If more than one object matches the search criteria, the function will return the sum of all the matching object heights.

Parameters:

c Search criteria.

Example:

HeightValue:=Height(N='North Wall');



  Hide Criteria 
MiniCAD

VectorScript Declaration:

PROCEDURE   Hide
( c:CRITERIA ) ;

Python:

def  vs.Hide(c):
   return None

Description:

Hides any visible or grayed objects matching the specified search criteria.

Parameters:

c Search criteria.

Example:

Hide((C='Proposed Phase 2 Construction'));



  IsFlipped Criteria 
VectorWorks8.0

VectorScript Declaration:

FUNCTION   IsFlipped
( c:CRITERIA ) :REAL ;

Python:

def  vs.IsFlipped(c):
   return REAL

Description:

Returns the number of objects meeting the criteria that are flipped.

Parameters:

c Search criteria.

Example:

PROCEDURE CountFlippedDoorSymbols;
BEGIN
  Message(IsFlipped(S='*Door*'));
END;
RUN(CountFlippedDoorSymbols);

See Also:

IsObjectFlipped  



  LeftBound Criteria 
MiniCAD - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   LeftBound
( c:CRITERIA ) :REAL ;

Python:

def  vs.LeftBound(c):
   return REAL

Special Notes:

LeftBound is obsolete as of Vectorworks 2012

Description:

Returns the x-coordinate of the bounding box (top left corner) of an object matching the search criteria. If more than one object matches the search criteria, the function will return the left value of the last matching object found.

Parameters:

c Search criteria.

Example:

LeftBValue:=LeftBound(N='MyRect');



  LeftBoundN Criteria 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   LeftBoundN
( c:CRITERIA ) :REAL ;

Python:

def  vs.LeftBoundN(c):
   return REAL

Description:

Returns the x-coordinate of the bounding box (top left corner) of an object matching the search criteria. If more than one object matches the search criteria, the function will return the value of the coordinate of the leftmost matching object found.

Parameters:

c Search criteria.

Example:

LeftBValue:=LeftBoundN(N='MyRect');



  Length Criteria 
MiniCAD - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   Length
( c:CRITERIA ) :REAL ;

Python:

def  vs.Length(c):
   return REAL

Special Notes:

Length is obsolete as of Vectorworks 2012

Description:

Returns the length of an object. If more than one object matches the search criteria, the function will return the sum of all the matching object lengths.

Parameters:

c Search criteria.

Example:

LengthValue:=Length(C='CrossMembers');
{returns the length of all objects in class 'CrossMembers'}



  LengthN Criteria 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   LengthN
( c:CRITERIA ) :REAL ;

Python:

def  vs.LengthN(c):
   return REAL

Description:

Returns the length of an object. If more than one object matches the search criteria, the function will return the sum of all the matching object lengths.

Parameters:

c Search criteria.

Example:

LengthValue:=LengthN(C='CrossMembers');
{returns the length of all objects in class 'CrossMembers'}



  ObjectType Criteria 
MiniCAD

VectorScript Declaration:

FUNCTION   ObjectType
( c:CRITERIA ) :INTEGER ;

Python:

def  vs.ObjectType(c):
   return INTEGER

Description:

Returns the type identifier an object. If more than one object matches the search criteria, the type identifier of the last matching object will be returned.


Parameters:

c Search criteria.

Example:

TypeValue:=ObjectType(N='Mystery Object');
{returns the type of the object named 'Mystery Object'}



  Perim Criteria 
MiniCAD - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   Perim
( c:CRITERIA ) :REAL ;

Python:

def  vs.Perim(c):
   return REAL

Special Notes:

Perim is obsolete as of Vectorworks 2012

Description:

Returns the perimeter of an object. If more than one object matches the search criteria, the function will return the sum of the matching objects' perimeters.

Parameters:

c Search criteria.

Example:

PerimValue := Perim(C='Fence');
{returns the total perimeter of all objects in the class 'Fence'}



  PerimN Criteria 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   PerimN
( c:CRITERIA ) :REAL ;

Python:

def  vs.PerimN(c):
   return REAL

Description:

Returns the perimeter of an object. If more than one object matches the search criteria, the function will return the sum of the matching objects' perimeters.

Parameters:

c Search criteria.

Example:

PerimValue := PerimN(C='Fence');
{returns the total perimeter of all objects in the class 'Fence'}



  RightBound Criteria 
MiniCAD - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   RightBound
( c:CRITERIA ) :REAL ;

Python:

def  vs.RightBound(c):
   return REAL

Special Notes:

RightBound is obsolete as of Vectorworks 2012

Description:

Returns the x-coordinate of the bounding box (bottom right corner) of an object matching the search criteria If more than one object matches the search criteria, the function will return the sum of the coordinates of all the matching objects.

Parameters:

c Search criteria.

Example:

RightBValue:=RightBound(N='MyRect');



  RightBoundN Criteria 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   RightBoundN
( c:CRITERIA ) :REAL ;

Python:

def  vs.RightBoundN(c):
   return REAL

Description:

Returns the x-coordinate of the bounding box (bottom right corner) of an object matching the search criteria If more than one object matches the search criteria, the function will return the value of the coordinate of the rightmost matching object found.

Parameters:

c Search criteria.

Example:

RightBValue:=RightBoundN(N='MyRect');



  RoofArea_Heated Criteria 
Vectorworks 2009

VectorScript Declaration:

FUNCTION   RoofArea_Heated
( c:CRITERIA ) :REAL ;

Python:

def  vs.RoofArea_Heated(c):
   return REAL

Description:

Returns the heated (interior) area along the slope of roofs or roof faces that meet the criteria.



  RoofArea_HeatedProj Criteria 
Vectorworks 2009

VectorScript Declaration:

FUNCTION   RoofArea_HeatedProj
( c:CRITERIA ) :REAL ;

Python:

def  vs.RoofArea_HeatedProj(c):
   return REAL

Description:

Returns the heated (interior) area projected on the ground plane of roofs or roof faces that meet the criteria.



  RoofArea_Total Criteria 
Vectorworks 2009

VectorScript Declaration:

FUNCTION   RoofArea_Total
( c:CRITERIA ) :REAL ;

Python:

def  vs.RoofArea_Total(c):
   return REAL

Description:

Returns the total area along the slope of roofs or roof faces that meet the criteria.



  RoofArea_TotalProj Criteria 
Vectorworks 2009

VectorScript Declaration:

FUNCTION   RoofArea_TotalProj
( c:CRITERIA ) :REAL ;

Python:

def  vs.RoofArea_TotalProj(c):
   return REAL

Description:

Returns the total area projected on the ground plane of roofs or roof faces that meet the criteria.



  SelectObj Criteria 
MiniCAD

VectorScript Declaration:

PROCEDURE   SelectObj
( c:CRITERIA ) ;

Python:

def  vs.SelectObj(c):
   return None

Description:

Selects all objects which match the search criteria.

Parameters:

c Search criteria.

Example:

PROCEDURE Example;
VAR
	red, green, blue, color :LONGINT;
	criteria :STRING;
BEGIN
	red := 65535;
	green := 0;
	blue := 0;
	RGBToColorIndex(red, green, blue, color);
	Rect(0, 0, 1, 1);
	SetPenFore(LNewObj, color);
	DSelectAll;
	criteria := Concat('(INSYMBOL & INVIEWPORT & (PF=', color, '))');
	SelectObj(criteria);
	Message(criteria);
END;
RUN(Example);



  Show Criteria 
MiniCAD

VectorScript Declaration:

PROCEDURE   Show
( c:CRITERIA ) ;

Python:

def  vs.Show(c):
   return None

Description:

Displays any hidden or grayed objects matching the specified search criteria.

Parameters:

c Search criteria.

Example:

Show((C='Proposed Phase 2 Construction'));



  SlabThickness Criteria 
VectorWorks12.0

VectorScript Declaration:

FUNCTION   SlabThickness
( c:CRITERIA ) :REAL ;

Python:

def  vs.SlabThickness(c):
   return REAL

Description:

Returns the thickness of slab objects that meet the criteria.



  SurfaceArea Criteria 
VectorWorks8.0 - obsolete as of VectorWorks12.5

VectorScript Declaration:

FUNCTION   SurfaceArea
( c:CRITERIA ) :REAL ;

Python:

def  vs.SurfaceArea(c):
   return REAL

Special Notes:

SurfaceArea is obsolete as of VectorWorks12.5

Description:

Returns the surface area of the items matching the specified criteria. If more than one object matches the search criteria, the sum of all the surface areas of the matching objects will be returned.

SurfaceArea will return only return areas on objects which support the solids modelling functions.

Parameters:

c Search criteria.

Example:

totalArea:=SurfaceArea((C='Empty Space'));



  SurfaceAreaN Criteria 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   SurfaceAreaN
( c:CRITERIA ) :REAL ;

Python:

def  vs.SurfaceAreaN(c):
   return REAL

Description:

Returns the surface area of the items matching the specified criteria. If more than one object matches the search criteria, the sum of all the surface areas of the matching objects will be returned.

SurfaceAreaN will only return areas on objects which support the solids modelling functions.

Parameters:

c Search criteria.

Example:

totalArea:=SurfaceAreaN((C='Empty Space'));



  TopBound Criteria 
MiniCAD - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   TopBound
( c:CRITERIA ) :REAL ;

Python:

def  vs.TopBound(c):
   return REAL

Special Notes:

TopBound is obsolete as of Vectorworks 2012

Description:

Returns the y-coordinate of the bounding box (top left corner) of an object matching the search criteria. If more than one object matches the search criteria, the function will return the sum of the coordinates of all the matching objects.

Parameters:

c Search criteria.

Example:

TopBValue:=TopBound(N='MyRect');



  TopBoundN Criteria 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   TopBoundN
( c:CRITERIA ) :REAL ;

Python:

def  vs.TopBoundN(c):
   return REAL

Description:

Returns the y-coordinate of the bounding box (top left corner) of an object matching the search criteria. If more than one object matches the search criteria, the function will return the value of the coordinate of the topmost matching object found.

Parameters:

c Search criteria.

Example:

TopBValue:=TopBoundN(N='MyRect');



  Volume Criteria 
VectorWorks8.0 - obsolete as of VectorWorks12.5

VectorScript Declaration:

FUNCTION   Volume
( c:CRITERIA ) :REAL ;

Python:

def  vs.Volume(c):
   return REAL

Special Notes:

Volume is obsolete as of VectorWorks12.5

Description:

Returns the volume of the items matching the specified criteria. If more than one object matches the search criteria, the sum of all the volumes of the matching objects will be returned.

Volume will return only return volumes on objects which support the solids modelling functions.

Parameters:

c Search criteria.

Example:

totalVol:=Volume((C='Empty Space'));



  VolumeN Criteria 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   VolumeN
( c:CRITERIA ) :REAL ;

Python:

def  vs.VolumeN(c):
   return REAL

Description:

Returns the volume of the items matching the specified criteria. If more than one object matches the search criteria, the sum of all the volumes of the matching objects will be returned.

VolumeN will only return volumes on objects which support the solids modelling functions.

Parameters:

c Search criteria.

Example:

totalVol:=VolumeN((C='Empty Space'));



  WallArea_Gross Criteria 
VectorWorks12.0

VectorScript Declaration:

FUNCTION   WallArea_Gross
( c:CRITERIA ) :REAL ;

Python:

def  vs.WallArea_Gross(c):
   return REAL

Description:

Returns the 2D gross surface area of walls that meet the criteria.



  WallArea_Net Criteria 
VectorWorks12.0

VectorScript Declaration:

FUNCTION   WallArea_Net
( c:CRITERIA ) :REAL ;

Python:

def  vs.WallArea_Net(c):
   return REAL

Description:

Returns the 2D gross surface area without doors and windows areas of walls that meet he criteria.



  WallAverageHeight Criteria 
VectorWorks12.0

VectorScript Declaration:

FUNCTION   WallAverageHeight
( c:CRITERIA ) :REAL ;

Python:

def  vs.WallAverageHeight(c):
   return REAL

Description:

Returns the average height of walls, including wall peaks and different starting and ending heights.



  WallThickness Criteria 
VectorWorks12.0

VectorScript Declaration:

FUNCTION   WallThickness
( c:CRITERIA ) :REAL ;

Python:

def  vs.WallThickness(c):
   return REAL

Description:

Returns the thickness of walls that meet the criteria.



  Width Criteria 
MiniCAD

VectorScript Declaration:

FUNCTION   Width
( c:CRITERIA ) :REAL ;

Python:

def  vs.Width(c):
   return REAL

Description:

Returns the width of an object matching the search criteria. If more than one object matches the search criteria, the function will return the sum of the matching object widths.

Parameters:

c Search criteria.

Example:

WidthValue:=Width(N='Box');



  XCenter Criteria 
MiniCAD - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   XCenter
( c:CRITERIA ) :REAL ;

Python:

def  vs.XCenter(c):
   return REAL

Special Notes:

XCenter is obsolete as of Vectorworks 2012

Description:

Returns the x-coordinate of the center point of an object matching the serach criteria. If more than one object matches the search criteria, the function will return the sum of the coordinates of all the matching objects.

Parameters:

c Search criteria.

Example:

XCenValue:=XCenter(N='Board');
{returns the x-coord of the center of the named object 'Board'}



  XCenterN Criteria 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   XCenterN
( c:CRITERIA ) :REAL ;

Python:

def  vs.XCenterN(c):
   return REAL

Description:

Returns the x-coordinate of the center point of the bounding box of an object matching the search criteria. If more than one object matches the search criteria, the function will return the x-coordinate of the average center point of all the matching objects

Parameters:

c Search criteria.

Example:

XCenValue:=XCenterN(N='Board');
{returns the x-coord of the center of the bounding box the named object 'Board'



  XCoordinate Criteria 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   XCoordinate
( c:CRITERIA ) :REAL ;

Python:

def  vs.XCoordinate(c):
   return REAL

Description:

Returns the X coordinate of the object relative to the user origin.

Parameters:

c The search criteria string.



  YCenter Criteria 
MiniCAD - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   YCenter
( c:CRITERIA ) :REAL ;

Python:

def  vs.YCenter(c):
   return REAL

Special Notes:

YCenter is obsolete as of Vectorworks 2012

Description:

Returns the y-coordinate of the center point of an object matching the serach criteria. If more than one object matches the search criteria, the function will return the sum of the coordinates of all the matching objects.

Parameters:

c Search criteria.

Example:

YCenValue:=YCenter(N='Board');
{returns the y-coord of the center of the named object 'Board'}



  YCenterN Criteria 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   YCenterN
( c:CRITERIA ) :REAL ;

Python:

def  vs.YCenterN(c):
   return REAL

Description:

Returns the y-coordinate of the center point of the bounding box of an object matching the search criteria. If more than one object matches the search criteria, the function will return the y-coordinate of the average center point of all the matching objects

Parameters:

c Search criteria.

Example:

YCenValue:=YCenterN(N='Board');
{returns the y-coord of the center of the bounding box of the named object 'Board'



  YCoordinate Criteria 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   YCoordinate
( c:CRITERIA ) :REAL ;

Python:

def  vs.YCoordinate(c):
   return REAL

Description:

Returns the Y coordinate of the object relative to the user origin.

Parameters:

c The search criteria string.



  ZCenter Criteria 
Vectorworks 2009 - obsolete as of Vectorworks 2012

VectorScript Declaration:

FUNCTION   ZCenter
( c:CRITERIA ) :REAL ;

Python:

def  vs.ZCenter(c):
   return REAL

Special Notes:

ZCenter is obsolete as of Vectorworks 2012

Description:

Returns the z-coordinate value of the center of an object matching the search criteria



  ZCenterN Criteria 
Vectorworks 2012

VectorScript Declaration:

FUNCTION   ZCenterN
( c:CRITERIA ) :REAL ;

Python:

def  vs.ZCenterN(c):
   return REAL

Description:

Returns the z-coordinate value of the center of the bounding box of an object matching the search criteria. If more than one object matches the search criteria, the function will return the z-coordinate of the average center point of all the matching objects

Parameters:

c Search criteria.

Example:

ZCenValue:=ZCenterN(N='Board');
{returns the z-coord of the center of the bounding box of the named object 'Board'



  ZCoordinate Criteria 
Vectorworks 2011

VectorScript Declaration:

FUNCTION   ZCoordinate
( c:CRITERIA ) :REAL ;

Python:

def  vs.ZCoordinate(c):
   return REAL

Description:

Returns the Z coordinate of the object relative to the layer plane.

Parameters:

c The search criteria string.