BeginMultipleDuplicate Object Editing 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   BeginMultipleDuplicate
;

Python:

def  vs.BeginMultipleDuplicate():
   return None

Description:

Use this function in conjunction with EndMultipleDuplicate to preserve constraints on multiple duplicated objects.

説明

この手続きを EndMultipleDuplicate と共に使用して、複製された図形の拘束を保持します。

See Also:

EndMultipleDuplicate  



  CreateDuplicateObject Object Editing 
VectorWorks12.5

VectorScript Declaration:

FUNCTION   CreateDuplicateObject
(   objectToDuplicate :HANDLE;
    containerHandle :HANDLE
) :HANDLE ;

Python:

def  vs.CreateDuplicateObject(objectToDuplicate, containerHandle):
   return HANDLE

Description:

Duplicates the specified object and inserts the new object into the container. If container is nil, the new object will be inserted in the active container.

説明

ハンドルで指定した図形を複製し、新しく作成された図形をハンドルで指定したコンテナに挿入します。コンテナのハンドルがNILならば、新しく作成された図形をアクティブなコンテナに挿入します。

Parameters:

objectToDuplicate The object to be duplicated 複製する図形のハンドル
containerHandle The container to the newly duplicated object 新しく複製された図形のコンテナのハンドル



  CreateDuplicateObjN Object Editing 
Vectorworks 2020

VectorScript Declaration:

FUNCTION   CreateDuplicateObjN
(   objectToDuplicate :HANDLE;
    containerHandle :HANDLE;
    maintainHeightRelativeToLayer :BOOLEAN
) :HANDLE ;

Python:

def  vs.CreateDuplicateObjN(objectToDuplicate, containerHandle, maintainHeightRelativeToLayer):
   return HANDLE

Description:

Duplicates the specified object and inserts the new object into the container. If container is nil, the new object will be inserted in the active container (Functionlaity of CreateDuplicateObject). This functions add an extra input paramer to maintain height relative to the specified layer.

説明

ハンドルで指定した図形を複製し、新しく作成された図形をハンドルで指定したコンテナに挿入します。コンテナのハンドルがNILならば、新しく作成された図形をアクティブなコンテナに挿入します( CreateDuplicateObject と同じ機能 )。 CreateDuplicateObjectN では、指定したレイヤの高さ基準を保持します。



  DeleteObjs Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   DeleteObjs
;

Python:

def  vs.DeleteObjs():
   return None

Description:

Procedure DeleteObjs deletes all selected objects on the active layer. Using this procedure when the layer display mode is Show/Snap/Modify will cause selected objects on any visible layer will be deleted.

説明

アクティブなレイヤ上の選択された図形を削除します。

Example:

DSelectAll;
SelectObj(((T=Locus) & (NOT V)));
DeleteObjs;



  DeleteSymbolDefinition Object Editing 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   DeleteSymbolDefinition
(   hSymDef :HANDLE;
    bCompletely :BOOLEAN
) ;

Python:

def  vs.DeleteSymbolDefinition(hSymDef, bCompletely):
   return None

Description:

Procedure DeleteSymbolDefinition deletes the referenced symbol definition from the document. If bCompletely is TRUE, all corresponding symbol instances will be deleted completely; otherwise, the symbol instances will be replaced with loci.

説明

ドキュメントから参照中のシンボル定義を削除します。
bCompletely が TRUE　ならば、すべてのシンボルを削除します。
FALSE ならば、ローカルなシンボルに置き換えます。

Parameters:

hSymDef Handle to the symbol definition. シンボル定義のハンドル
bCompletely Determines whether to replace the corresponding symbol instances with loci or delete the instances completely. すべてのシンボルを削除するか、ローカルなシンボルに置き換えるか、指定します



  DelObject Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   DelObject
( h:HANDLE ) ;

Python:

def  vs.DelObject(h):
   return None

Description:

Procedure DelObject deletes the referenced object from the document.

説明

ハンドルで指定した図形、レイヤ、ワークシートを削除します。

Parameters:

h Handle to object. 図形、レイヤ、ワークシートのハンドル



  Duplicate Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   Duplicate
(   offsetDX :REAL;
    offsetDY :REAL
) ;

Python:

def  vs.Duplicate(offset):
   return None

Description:

Procedure Duplicate copies the currently selected objects and moves them the specified offset distance.

説明

選択されている図形を複製し、指定した位置に移動させます。
他のレイヤが「表示+スナップ+編集」の場合、他のレイヤ上の選択されている図形も複製されます。

Parameters:

offset Offset value. 複製した図形の相対的な座標

Example:

Rect(0,1,1,0);
Duplicate(2,0);
{duplicates the rectangle 2 units right of the original}



  EditObjectSpecial Object Editing 
Vectorworks 2013

VectorScript Declaration:

PROCEDURE   EditObjectSpecial
(   h :HANDLE;
    editMode :INTEGER
) ;

Python:

def  vs.EditObjectSpecial(h, editMode):
   return None

Description:

Edit the specified object.

説明

指定した図形を編集します。

Parameters:

h The object to edit. 図形のハンドル
editMode The edit mode: 0-Default; 2-Properties; 3-Reshape; 4-Edit group like; 編集モード
0 : デフォルトモード
2 : プロパティモード[[BR}] 3 : 再成形モード
4 : グループモード



  EndMultipleDuplicate Object Editing 
Vectorworks 2011

VectorScript Declaration:

PROCEDURE   EndMultipleDuplicate
;

Python:

def  vs.EndMultipleDuplicate():
   return None

Description:

Use this function in conjunction with BeginMultipleDuplicate to preserve constraints on duplicated objects.

説明

この手続きを BeginMultipleDuplicate と共に使用して、複製された図形の拘束を保持します。

See Also:

BeginMultipleDuplicate  



  GetAssociation Object Editing 
Vectorworks 2018

VectorScript Declaration:

FUNCTION   GetAssociation
(   handle :HANDLE;
    index :INTEGER;
  VAR  associationkind :INTEGER;
  VAR  value :INTEGER
) :HANDLE ;

Python:

def  vs.GetAssociation(handle, index):
   return (HANDLE, associationkind, value)

Description:

Gets info about association of specified object.

説明

指定したオブジェクトの関連付けの情報を取得します。

Parameters:

handle Associated object handle. オブジェクトのハンドル
index Index of association. 関連付け情報のインデックス
associationkind Kind of association - reset or delete action 関連付けの種類 - リセット or 削除

Result:

HANDLE

返り値

ハンドル



  GetNumAssociations Object Editing 
Vectorworks 2018

VectorScript Declaration:

FUNCTION   GetNumAssociations
( handle:HANDLE ) :INTEGER ;

Python:

def  vs.GetNumAssociations(handle):
   return INTEGER

Description:

Get number of associations for specified object.

説明

指定したオブジェクトの関連付けの数を返します。

Parameters:

handle Object handle. オブジェクトのハンドル

Result:

INTEGER

返り値

関連付けの数を返します。



  HDuplicate Object Editing 
VectorWorks10.0

VectorScript Declaration:

FUNCTION   HDuplicate
(   objectHandle :HANDLE;
    x :REAL;
    y :REAL
) :HANDLE ;

Python:

def  vs.HDuplicate(objectHandle, x, y):
   return HANDLE

Description:

Duplicates and moves an object by the offsets specified.

説明

ハンドルで指定した図形を複製し、指定した距離で動かします。

Parameters:

objectHandle Handle to the object to duplicate 図形のハンドル
x X-coordinate of distance object should be shifted from original location X軸方向への移動距離
y Y-coordinate of distance object should be shifted from original location Y軸方向への移動距離

Result:

Returns a handle to the new object.

返り値

新しく作成された図形のハンドルを返します。



  HMove Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   HMove
(   h :HANDLE;
    xOffset :REAL;
    yOffset :REAL
) ;

Python:

def  vs.HMove(h, xOffset, yOffset):
   return None

Description:

Procedure HMove moves the referenced object a relative offset distance.

説明

ハンドルで指定した図形を移動します。

Parameters:

h Handle to object. 図形のハンドル
xOffset X offset distance. X軸方向への移動距離
yOffset Y offset distance. Y軸方向への移動距離

Example:

HMove(handleToObject,2,2);



  HMoveBackward Object Editing 
VectorWorks8.5

VectorScript Declaration:

PROCEDURE   HMoveBackward
(   h :HANDLE;
    toBack :BOOLEAN
) ;

Python:

def  vs.HMoveBackward(h, toBack):
   return None

Description:

Move the referenced object backward in the object stacking order. If toBack is TRUE, the object will be moved to the back of the stacking order.

説明

ハンドルで指定した図形を、前後関係の後ろへ移動します。

Parameters:

h Handle to object. 図形のハンドル
toBack Move to back of stacking order. 前後関係（TRUE：最後へ／FALSE：後ろへ）



  HMoveForward Object Editing 
VectorWorks8.5

VectorScript Declaration:

PROCEDURE   HMoveForward
(   h :HANDLE;
    toFront :BOOLEAN
) ;

Python:

def  vs.HMoveForward(h, toFront):
   return None

Description:

Move the referenced object forward in the object stacking order. If toFront is TRUE, the object will be moved to the front of the stacking order.

説明

ハンドルで指定した図形を、前後関係の前へ移動します。

Parameters:

h Handle to object. 図形のハンドル
toFront Move object to front of stacking order. 前後関係（TRUE：最前へ／FALSE：前へ）

Example:

PROCEDURE Example;
BEGIN
	HMoveForward(FSActLayer, FALSE);
END;
RUN(Example);



  HRotate Object Editing 
MiniCAD6.0

VectorScript Declaration:

PROCEDURE   HRotate
(   h :HANDLE;
    centerX :REAL;
    centerY :REAL;
    rotationAngle :REAL
) ;

Python:

def  vs.HRotate(h, center, rotationAngle):
   return None

Description:

Procedure HRotate rotates the referenced object about a coordinate point location. rotationAngle is in degrees.

説明

ハンドルで指定した図形を、指定した座標を基点として回転させます。

Parameters:

h Handle to object. 図形のハンドル
center X-Y coordinates of center point of rotation. 回転の基準となるX、Y座標
rotationAngle Angle of rotation. 回転角度

Example:

HRotate(objHd,3,5,60d);



  HScale2D Object Editing 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   HScale2D
(   h :HANDLE;
    centerX :REAL;
    centerY :REAL;
    scaleX :REAL;
    scaleY :REAL;
    scaleText :BOOLEAN
) ;

Python:

def  vs.HScale2D(h, centerX, centerY, scaleX, scaleY, scaleText):
   return None

Description:

Scales a 2D object.

説明

2Dオブジェクトのスケール（倍率）を変更します。



  HScale3D Object Editing 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   HScale3D
(   h :HANDLE;
    centerX :REAL;
    centerY :REAL;
    centerZ :REAL;
    scaleX :REAL;
    scaleY :REAL;
    scaleZ :REAL
) ;

Python:

def  vs.HScale3D(h, centerX, centerY, centerZ, scaleX, scaleY, scaleZ):
   return None

Description:

Scales a 3D object.

説明

3Dオブジェクトのスケール（倍率）を変更します。



  Mirror Object Editing 
Vectorworks 2017

VectorScript Declaration:

FUNCTION   Mirror
(   h :HANDLE;
    dup :BOOLEAN;
    p1 :POINT;
    p2 :POINT
) :HANDLE ;

Python:

def  vs.Mirror(h, dup, p1, p2):
   return HANDLE

Description:

Reflect an object across an axis.

For a 2D reflection, the axis is a line containing arbitrary point p and extending along vector v.

説明

境界線を境に図形を反転します。

2Dでの反転を想定しており、境界線は任意の2点を含みv方向に伸びる直線となります。

Parameters:

h The object to reflect 図形のハンドル
dup If false, transform the original object to the new position. If true, create a new object 複製モード
False : 入力した図形を反転した位置に変換
True : 新しい図形を反転した位置に作成
p1 An arbitrary point on the mirror axis 1つ目の点の座標
p2 A second arbitrary point on the mirror axis 2つ目の点の座標

Result:

The reflected object (this will be the same as the input object if dup is false).

返り値

反転した図形のハンドル (複製(dup引数)がFalseの場合は入力したハンドルと同じになります。)



  MirrorN Object Editing 
Vectorworks 2023

VectorScript Declaration:

FUNCTION   MirrorN
(   h :HANDLE;
    dup :BOOLEAN;
    p1 :POINT;
    p2 :POINT;
    preserveMatrix :BOOLEAN
) :HANDLE ;

Python:

def  vs.MirrorN(h, dup, p1, p2, preserveMatrix):
   return HANDLE

Description:

Reflect an object across an axis.

For a 2D reflection, the axis is a line containing arbitrary point p and extending along vector v.

The difference with Mirror, when preserveMatrix is set to true, is that this function preserves the matrix of the objects that have one, which leads to better visual results.

説明

境界線を境に図形を反転します。2Dでの反転を想定しており、境界線は任意の2点を含みv方向に伸びる直線となります。preserveMatrixがTRUEに設定されている場合のMirror関数との違いは、この関数が行列を持つオブジェクトの行列を保持することであり、より良い視覚結果をもたらします。

Parameters:

h The object to reflect 反転するオブジェクト
dup If false, transform the original object to the new position. If true, create a new object False : 入力した図形を反転した位置に変換
True : 新しい図形を反転した位置に作成
p1 An arbitrary point on the mirror axis 1つ目の点の座標
p2 A second arbitrary point on the mirror axis 2つ目の点の座標
preserveMatrix When this parameter is set to false, then this function works exactly the same as Mirror. Otherwise, objects that have matrices, such as Symbols and PIOs, get their matrices updated correctly with the mirror matrix, leading to better visual results. このパラメータをfalseに設定した場合、この関数はMirror関数と全く同じように動作します。そうでない場合、シンボルやプラグインオブジェクトのような行列を持つオブジェクトは、その行列がミラー行列で正しく更新され、より良い視覚的結果につながります。

Result:

The reflected object (this will be the same as the input object if dup is false).

返り値

反転した図形のハンドル (複製(dup引数)がFalseの場合は入力したハンドルと同じになります。)



  Move3D Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   Move3D
(   xDistance :REAL (Coordinate);
    yDistance :REAL (Coordinate);
    zDistance :REAL (Coordinate)
) ;

Python:

def  vs.Move3D(xDistance, yDistance, zDistance):
   return None

Description:

Procedure Move3D moves the most recently created three-dimensional object a relative distance from it's original location. The object is moved relative to its center.

説明

直前に作成された3次元図形を、相対的な量で移動します。

Parameters:

xDistance X offset distance. X軸方向への移動距離
yDistance Y offset distance. Y軸方向への移動距離
zDistance Z offset ditance. Z軸方向への移動距離

Example:

BeginXtrd(0',2");
Rect(0",1",1",0");
EndXtrd;
Move3D(3",1",2");



  Move3DObj Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   Move3DObj
(   h :HANDLE;
    xDistance :REAL (Coordinate);
    yDistance :REAL (Coordinate);
    zDistance :REAL (Coordinate)
) ;

Python:

def  vs.Move3DObj(h, xDistance, yDistance, zDistance):
   return None

Description:

Procedure Move3DObj moves the referenced object a specified distance from its current location. Movement distances are calculated from the 3D center of the object.

説明

ハンドルで指定した3次元図形を、相対的な量で移動します。

Parameters:

h Handle to object. 3次元図形のハンドル
xDistance X offset distance. X軸方向への移動距離
yDistance Y offset distance. Y軸方向への移動距離
zDistance Z offset distance. Z軸方向への移動距離

Example:

Move3DObj(HandleToObj,2,4,0);



  MoveObjs Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   MoveObjs
(   moveDX :REAL;
    moveDY :REAL;
    allLayers :BOOLEAN;
    allObjects :BOOLEAN
) ;

Python:

def  vs.MoveObjs(move, allLayers, allObjects):
   return None

Description:

Procedure MoveObjs moves object(s) a specified offset distance. The last two parameters, allLayers and allObjects, control which objects are offset by this procedure.

Table - Effect of MoveObjs Parameters

allLayers allObjects Effect
TRUE TRUE Move all objects on all layers
TRUE FALSE Move selected objects on all layers
FALSE TRUE Move all objects on active layer
FALSE FALSE Move selected objects on active layer

説明

選択されている図形を、相対的な量で移動します。

Parameters:

move X-Y object offset distance. X、Y軸方向への移動距離
allLayers Move objects on all layers option setting. すべてのレイヤ上の図形を対象にする場合はTRUE
allObjects Move all objects option setting. すべての図形を移動する場合はTRUE

Example:

MoveObjs(3,0,FALSE,FALSE);
{ moves selected objects on active layer 3 units to the right }



  OffsetHandle Object Editing 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   OffsetHandle
(   h :HANDLE;
    offsetDistance :REAL;
    EdgeRestoration :BOOLEAN;
    FilletSharpEdges :BOOLEAN
) :HANDLE ;

Python:

def  vs.OffsetHandle(h, offsetDistance, EdgeRestoration, FilletSharpEdges):
   return HANDLE

Description:

Creates a group of lines which represent the weighted medial axis of given polygon.

説明

与えられた多角形の重み付き中心軸を一群の線として生成します。



  ResetBBox Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   ResetBBox
( h:HANDLE ) ;

Python:

def  vs.ResetBBox(h):
   return None

Description:

Procedure ResetBBox forces the bounding box information for the specified object to be recomputed based on the objects' current geometry.

Call this procedure after modifying an object to force a redraw of the object.

説明

ハンドルで指定した図形の領域を再計算します。

Parameters:

h Handle to object. 図形のハンドル



  SetBBox Object Editing 
MiniCAD

VectorScript Declaration:

PROCEDURE   SetBBox
(   h :HANDLE;
    p1X :REAL;
    p1Y :REAL;
    p2X :REAL;
    p2Y :REAL
) ;

Python:

def  vs.SetBBox(h, p1, p2):
   return None

Description:

Procedure SetBBox positions objects whose geometry is defined by a bounding box. These objects currently are Image, PICT, Rectangle, Oval, Rounded Rectangle, and Worksheet Container.

Other objects will generate a warning if they are passed to SetBBox.

説明

ハンドルで指定した図形の領域を、指定した座標で設定します。

Parameters:

h Handle to object. 図形のハンドル
p1 Top left coordinate of bounding box. 左上の座標
p2 Bottom right coordinate of bounding box. 右下の座標



  SetHDef Object Editing 
MiniCAD6.0

VectorScript Declaration:

PROCEDURE   SetHDef
(   oldH :HANDLE;
    newH :HANDLE
) ;

Python:

def  vs.SetHDef(oldH, newH):
   return None

Description:

Procedure SetHDef replaces the definition of the referenced "container" object with a new definition. Supported object types are worksheets, symbol definitions, and layer references.

説明

ワークシートやシンボル、リンクされたレイヤで参照されている図形を置き換えます。

Parameters:

oldH Handle to object. 変更されるシンボルのハンドル
newH Handle to new definition. 置き換えるシンボルのハンドル

Example:

SetHDef(symbolHd,newSymDefHd);
{updates the referenced symbol with a new definition}



  SetRRDiam Object Editing 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   SetRRDiam
(   h :HANDLE;
    xDiam :REAL;
    yDiam :REAL
) ;

Python:

def  vs.SetRRDiam(h, xDiam, yDiam):
   return None

Description:

Sets the diameters of a rounded rectangle.

説明

隅の丸い四角形の隅のアール半径を設定します。