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.

返り値

検索条件に合致した図形が線分や円弧でない場合は、0を返します。

Example:

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

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.

説明

検索条件に合致した図形の面積を返します。検索条件に合致した図形が複数ある場合は合計を返します。
この関数は使用できなくなりましたので、CriteriaAreaを使用してください。

Parameters:

c

Search criteria.

検索条件

Example:

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

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.

説明

検索条件に合致した図形の面積を返します。検索条件に合致した図形が複数ある場合は合計を返します。
この関数は使用できなくなりましたので、CriteriaAreaを使用してください。

Parameters:

c

Search criteria.

検索条件

Example:

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

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.

説明

検索条件に合致した図形の下辺のY座標を返します。検索条件に合致した図形が複数ある場合は、最後に合致した図形の値を返します。

Parameters:

c

Search criteria.

検索条件

Example:

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

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.

説明

検索条件に合致した図形の下辺のY座標を返します。検索条件に合致した図形が複数ある場合は、一番下の図形の値を返します。

Parameters:

c

Search criteria.

検索条件

Example:

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

VectorScript Declaration:

PROCEDURE   CheckoutObj

( c:CRITERIA ) ;

Python:

def  vs.CheckoutObj(c):

   return None

Description:

Checkouts all objects which match the search criteria.

説明

検索条件に合致するすべてのオブジェクトをチェックアウトします。

Parameters:

c

Search criteria

検索条件

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.

説明

指定した構成要素の片面の面積を返します。3D 図形の開口を考慮 (差し引き) します。

Parameters:

c	The search criteria string	検索条件
index	The index of the component.	コンポーネント番号

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.

説明

指定した構成要素の3D 容積を返します。3D 図形の開口を考慮 (差し引き) します。

Parameters:

c	The search criteria string.	検索条件
index	The index of the component.	コンポーネント番号

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}

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'}

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

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

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}

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.

検索条件

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

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

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

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

VectorScript Declaration:

PROCEDURE   Hide

( c:CRITERIA ) ;

Python:

def  vs.Hide(c):

   return None

Description:

Changes the object visibility to "invisible" for objects matching the specified search criteria. Hidden objects can be made visible with Show or UnHideObjects commands. Affects only objects on visible layers and classes.

説明

検索条件に合致した図形を隠します。

Parameters:

c

Search criteria.

検索条件

Example:

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

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  

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.

説明

検索条件に合致した図形の左辺のX座標を返します。検索条件に合致した図形が複数ある場合は、最後に合致した図形の値を返します。

Parameters:

c

Search criteria.

検索条件

返り値

左辺のX座標の合計

Example:

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

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.

説明

検索条件に合致した図形の左辺のX座標を返します。検索条件に合致した図形が複数ある場合は、一番左の図形の値を返します。

Parameters:

c

Search criteria.

検索条件

Example:

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

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'}

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'}

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'}

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'}

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'}

VectorScript Declaration:

PROCEDURE   ReleaseObj

( c:CRITERIA ) ;

Python:

def  vs.ReleaseObj(c):

   return None

Description:

Releases all objects which match the search criteria.

説明

検索条件に合致したオブジェクトをリリースします。

Parameters:

c

Search criteria

検索条件

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.

説明

検索条件に合致した図形の右辺のX座標を返します。検索条件に合致した図形が複数ある場合は、最後に合致した図形の値を返します。

Parameters:

c

Search criteria.

検索条件

返り値

右辺のX座標の合計

Example:

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

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.

説明

検索条件に合致した図形の右辺のX座標を返します。検索条件に合致した図形が複数ある場合は、右端の図形の値を返します。

Parameters:

c

Search criteria.

検索条件

Example:

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

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.

説明

検索条件に合致した屋根、屋根面の勾配に沿った暖房領域の面積を返します。暖房領域は軒の出を含まない領域です。

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.

説明

検索条件に合致した屋根、屋根面の暖房領域の水平投影面積を返します。暖房領域は軒の出を含まない領域です。

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.

説明

検索条件に合致した屋根、屋根面の勾配に沿った総面積を返します。

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.

説明

検索条件に合致した屋根、屋根面の水平投影面積を返します。

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

VectorScript Declaration:

PROCEDURE   Show

( c:CRITERIA ) ;

Python:

def  vs.Show(c):

   return None

Description:

Changes the object visibility to "visible" for objects matching the specified search criteria. This is for object visibilities that were hidden with Hide, HideSelectedObjects and ShowOnlySelected commands. The object will only become visible if it is also on a visible layer and class.

説明

隠されているまたは、グレイ表示されている図形で検索条件に合致したものを表示します。

Parameters:

c

Search criteria.

検索条件

Example:

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

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.

説明

検索条件に合致したスラブの厚さを返します。

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.

説明

検索条件に合致したソリッドの表面積を返します。検索条件に合致した図形が複数ある場合は合計を返します。
この関数は使用できなくなりましたので、CriteriaSurfaceAreaを使用してください。

Parameters:

c

Search criteria.

検索条件

返り値

表面積

Example:

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

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

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.

説明

検索条件に合致した図形の上辺のY座標を返します。検索条件に合致した図形が複数ある場合は合計を返します。

Parameters:

c

Search criteria.

検索条件

返り値

上辺のY座標の合計

Example:

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

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.

説明

検索条件に合致した図形の上辺のY座標を返します。検索条件に合致した図形が複数ある場合は最上位の座標の値が返されます。

Parameters:

c

Search criteria.

検索条件

Example:

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

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.

説明

検索条件に合致したソリッドの体積を返します。検索条件に合致した図形が複数ある場合は合計を返します。
この関数は使用できなくなりましたので、CriteriaVolumeを使用してください。

Parameters:

c

Search criteria.

検索条件

Example:

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

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

VectorScript Declaration:

FUNCTION   WallArea_Gross

( c:CRITERIA ) :REAL ;

Python:

def  vs.WallArea_Gross(c):

   return REAL

Description:

Returns the average of the gross area of the interior and exterior face of the wall. The gross area ignores holes in the wall.

説明

検索条件に合致した壁の内側と外側の表面積 (グロス) の平均値を返します。表面積 (グロス) は壁の中のドアや窓を含めた全体の面積です。

VectorScript Declaration:

FUNCTION   WallArea_Net

( c:CRITERIA ) :REAL ;

Python:

def  vs.WallArea_Net(c):

   return REAL

Description:

Returns the average of the net area of the interior and exterior face of the wall. The net area is adjusted for holes in the wall.

説明

検索条件に合致した壁の内側と外側の表面積 (ネット) の平均値を返します。表面積 (ネット) は壁全体の面積からドアと窓の面積を除いた値です。

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.

説明

検索条件に合致した壁の頂点、開始位置、終了位置の高さを含めて計算した平均の高さを返します。

VectorScript Declaration:

FUNCTION   WallThickness

( c:CRITERIA ) :REAL ;

Python:

def  vs.WallThickness(c):

   return REAL

Description:

Returns the thickness of walls that meet the criteria.

説明

検索条件に合致した壁の厚さを返します。

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

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.

説明

検索条件に合致した図形の中心のX座標を返します。検索条件に合致した図形が複数ある場合は合計を返します。

Parameters:

c

Search criteria.

検索条件

Example:

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

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

説明

検索条件に合致した図形の中心のX座標を返します。複数の図形が検索条件に一致する場合、この関数は、一致するすべての図形の平均的な中心点のx座標を返します。

Parameters:

c

Search criteria.

検索条件

Example:

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

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.

説明

ユーザ原点に基づく図形の X 座標を返します。

Parameters:

c

The search criteria string.

検索条件

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.

説明

検索条件に合致した図形の中心のY座標を返します。検索条件に合致した図形が複数ある場合は合計を返します。

Parameters:

c

Search criteria.

検索条件

Example:

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

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

説明

検索条件に合致した図形の中心のY座標を返します。複数の図形が検索条件に一致する場合、この関数は、一致するすべての図形の平均的な中心点のy座標を返します。

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'

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.

説明

ユーザ原点に基づく図形の Y 座標を返します。

Parameters:

c

The search criteria string.

検索条件

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

説明

検索条件に合致した図形の中心のZ座標を返します。検索条件に合致した図形が複数ある場合は合計を返します。

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

説明

検索条件に合致した図形の中心のZ座標を返します。複数の図形が検索条件に一致する場合、この関数は、一致するすべての図形の平均的な中心点のZ座標を返します。

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'

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.

説明

ユーザ原点に基づく図形の Z 座標を返します。

Parameters:

c

The search criteria string.

検索条件