VectorScript Declaration:

FUNCTION   ConsolidatePlanar

(   obj1 :HANDLE;     obj2 :HANDLE ) :BOOLEAN ;

Python:

def  vs.ConsolidatePlanar(obj1, obj2):

   return BOOLEAN

Description:

Modifies the plane of the second planar object so it is on the plane of the first object. Also moves the object so plane change doesn't affect it's position.

説明

2 番目のプレイナー図形の平面を変更して、最初の図形の平面上に配置します。また、図形を移動して、平面の変更がその位置に影響を与えないようにします。ConsolidatePlanarObjectsの代わりに使います。

Parameters:

obj1	Handle to the first object.	一つ目の図形のハンドル
obj2	Handle to the second object.	二つ目の図形のハンドル

VectorScript Declaration:

PROCEDURE   Get2DPt

(   obj :HANDLE;     index :INTEGER;   VAR  locX :REAL;   VAR  locY :REAL ) ;

Python:

def  vs.Get2DPt(obj, index):

   return loc

Description:

Returns the location of the specified vertex of a referenced object.

説明

ハンドルで指定した2次元図形の頂点座標を返します。

Parameters:

obj	Handle to object.	ハンドル図形
index	Index of vertex to be queried.	頂点
loc	Coordinates of 2D vertex location.	頂点の座標

VectorScript Declaration:

PROCEDURE   GetBBox

(   h :HANDLE;   VAR  p1X :REAL;   VAR  p1Y :REAL;   VAR  p2X :REAL;   VAR  p2Y :REAL ) ;

Python:

def  vs.GetBBox(h):

   return (p1, p2)

Description:

Procedure GetBBox returns the bounding box coordinates of the projection of the referenced object on the screen plane.

説明

ハンドルで指定した図形がおさまる最小の四角形の座標を返します。

Parameters:

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

VectorScript Declaration:

FUNCTION   GetObjectByUuid

( UUID:STRING ) :HANDLE ;

Python:

def  vs.GetObjectByUuid(UUID):

   return HANDLE

Description:

Function GetObjectByUuid returns a handle to the object with the specified UUID. If the UUID is not valid, or if no object with that UUID exists, NIL is returned.

説明

指定したUUIDでオブジェクトのハンドルを返します。UUIDが無効の場合、またはUUIDを持つオブジェクトが存在しない場合は、NILを返します。

Parameters:

UUID

Object UUID

オブジェクトのUUID

Result:

HANDLE

返り値

オブジェクトのハンドル

See Also:

GetObjectUuid  

VectorScript Declaration:

FUNCTION   GetObjectUuid

( h:HANDLE ) :STRING ;

Python:

def  vs.GetObjectUuid(h):

   return STRING

Description:

Function GetObjectUuid returns the UUID of the referenced object.

説明

指定したオブジェクトのUUIDを返します。

Parameters:

h

Handle to object

オブジェクトのハンドル

Result:

STRING

返り値

UUIDを文字列として返します。

See Also:

GetObjectByUuid  

VectorScript Declaration:

FUNCTION   GetObjectVariableBoolean

(   h :HANDLE;     index :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetObjectVariableBoolean(h, index):

   return BOOLEAN

Description:

Returns the ON-OFF status of a Vectorworks object property.

For specific object selector index values, see the Appendix.

説明

ハンドルで指定した図形の論理（BOOLEAN）設定値を返します。

Parameters:

h	Handle to object.	図形のハンドル
index	Object property index.	識別番号

Result:

Returns a BOOLEAN value indicating the ON-OFF status of the property.

返り値

論理（BOOLEAN）設定値を返します。

Example:

castShadow:= GetObjectVariableBoolean(h,53);

VectorScript Declaration:

FUNCTION   GetObjectVariableHandle

(   h :HANDLE;     index :INTEGER ) :HANDLE ;

Python:

def  vs.GetObjectVariableHandle(h, index):

   return HANDLE

Description:

Returns the value of a Vectorworks object property.

説明

ハンドルで指定した図形のハンドル（HANDLE）設定値を返します。

VectorScript Declaration:

FUNCTION   GetObjectVariableInt

(   h :HANDLE;     index :INTEGER ) :INTEGER ;

Python:

def  vs.GetObjectVariableInt(h, index):

   return 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.

説明

ハンドルで指定した図形の整数（INTEGER）設定値を返します。

Parameters:

h	Handle to object.	図形のハンドル
index	Object property index.	識別番号

Result:

Returns the value of the property as an INTEGER value.

返り値

整数（INTEGER）設定値を返します。

Example:

numCavities:= GetObjectVariableInt(h,199);

VectorScript Declaration:

FUNCTION   GetObjectVariableLongInt

(   h :HANDLE;     index :INTEGER ) :LONGINT ;

Python:

def  vs.GetObjectVariableLongInt(h, index):

   return 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.

説明

ハンドルで指定した図形の整数（LONGINT）設定値を返します。

Parameters:

h	Handle to object.	図形のハンドル
index	Object property index.	識別番号

Result:

Returns the value of the property as a LONGINT value.

返り値

整数（LONGINT）設定値を返します。

Example:

p:= GetObjectVariableLongInt(h,579);

VectorScript Declaration:

FUNCTION   GetObjectVariablePoint

(   h :HANDLE;     index :INTEGER;   VAR  outPX :REAL;   VAR  outPY :REAL;   VAR  outPZ :REAL ) :BOOLEAN ;

Python:

def  vs.GetObjectVariablePoint(h, index):

   return (BOOLEAN, outP)

Description:

Returns the value of a Vectorworks object property. Used with properties returning a 2D or 3D point value.

For specific object selector index values, see the Appendix.

説明

図形の設定値を返します。2D、3Dの点を返す設定値で利用します。

Parameters:

h	Handle to object.	図形のハンドル
index	Object property index.	識別番号
outP	Return the object variable data point.	point設定値を返します。

See Also:

SetObjectVariablePoint   GetObjectVariableBoolean   SetObjectVariableBoolean   GetObjectVariableHandle   SetObjectVariableHandle   GetObjectVariableInt   SetObjectVariableInt   GetObjectVariableLongInt   SetObjectVariableLongInt   GetObjectVariableReal   SetObjectVariableReal   GetObjectVariableString   SetObjectVariableString  

VectorScript Declaration:

FUNCTION   GetObjectVariableReal

(   h :HANDLE;     index :INTEGER ) :REAL ;

Python:

def  vs.GetObjectVariableReal(h, index):

   return 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.

説明

ハンドルで指定した図形の実数（REAL）設定値を返します。

Parameters:

h	Handle to object.	図形のハンドル
index	Object property index.	識別番号

Result:

Returns the value of the property as a REAL value.

返り値

実数（REAL）設定値を返します。

Example:

dim_offset:= GetObjectVariableReal(h,4);

VectorScript Declaration:

FUNCTION   GetObjectVariableString

(   h :HANDLE;     index :INTEGER ) :DYNARRAY[] of CHAR ;

Python:

def  vs.GetObjectVariableString(h, index):

   return DYNARRAY of CHAR

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.

説明

ハンドルで指定した図形の文字列（STRING）設定値を返します。

Parameters:

h	Handle to object.	図形のハンドル
index	Object property index.	識別番号

Result:

Returns the value of the property as a STRING value.

返り値

文字列（STRING）設定値を返します。

Example:

dimstdName:= GetObjectVariableString(h,27);

VectorScript Declaration:

FUNCTION   GetParent

( h:HANDLE ) :HANDLE ;

Python:

def  vs.GetParent(h):

   return 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.

返り値

コンテナまたは、レイヤのハンドルを返します。

VectorScript Declaration:

FUNCTION   GetPlanarRef

( h:HANDLE ) :LONGINT ;

Python:

def  vs.GetPlanarRef(h):

   return LONGINT

Description:

Get the plane ref ID of the specified object.

説明

指定した図形の平面参照番号を取得します。

Parameters:

h

Handle to the object.

図形のハンドル

VectorScript Declaration:

PROCEDURE   GetSymLoc

(   symHd :HANDLE;   VAR  pX :REAL;   VAR  pY :REAL ) ;

Python:

def  vs.GetSymLoc(symHd):

   return p

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	挿入点の座標

VectorScript Declaration:

FUNCTION   GetSymRot

( symHd:HANDLE ) :REAL ;

Python:

def  vs.GetSymRot(symHd):

   return REAL

Description:

Function GetSymRot returns the rotation angle (in degrees) of the referenced symbol or plug-in object.

説明

ハンドルで指定したシンボルやプラグインオブジェクトの回転角度（度数）を返します。

Parameters:

symHd

Handle to symbol.

シンボルのハンドル

VectorScript Declaration:

FUNCTION   GetType

( h:HANDLE ) :INTEGER ;

Python:

def  vs.GetType(h):

   return INTEGER

Special Notes:

GetType is obsolete as of Vectorworks 2011

Description:

Returns the type index of the referenced screen object.

説明

ハンドルで指定した図形の種類を番号で返します。

Parameters:

h

Handle to object.

図形のハンドル

返り値

図形の種類

See Also:

GetTypeN  

VectorScript Declaration:

FUNCTION   GetTypeN

( h:HANDLE ) :INTEGER ;

Python:

def  vs.GetTypeN(h):

   return INTEGER

Description:

Returns the type index of the referenced planar or screen object.

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

説明

ハンドルで指定した図形の種類を番号で返します。

Parameters:

h

Handle to object.

図形のハンドル

返り値

図形の種類

See Also:

GetType  

VectorScript Declaration:

FUNCTION   HAngle

( h:HANDLE ) :REAL ;

Python:

def  vs.HAngle(h):

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

VectorScript Declaration:

FUNCTION   HArea

( h:HANDLE ) :REAL ;

Python:

def  vs.HArea(h):

   return REAL

Special Notes:

HArea is obsolete as of VectorWorks12.5

Description:

Function HArea returns the area of the referenced object.

説明

ハンドルで指定した図形の面積を返します。
この関数は使用できなくなりましたので、ObjAreaを使用してください。

Parameters:

h

Handle to object.

図形のハンドル

VectorScript Declaration:

FUNCTION   HAreaN

( ObjectHandle:HANDLE ) :REAL ;

Python:

def  vs.HAreaN(ObjectHandle):

   return REAL

Description:

Compute the area of a given object, it has the same function as HArea(), but the result in case of polyline is more accurate.

説明

ハンドルで指定した図形の面積を返します。曲線の場合、関数HAreaより正確です。

Parameters:

ObjectHandle

It is the object we want to calculate its area.

図形のハンドル

Example:

HAreaN(object);

VectorScript Declaration:

FUNCTION   HHeight

( h:HANDLE ) :REAL ;

Python:

def  vs.HHeight(h):

   return REAL

Description:

Function HHeight returns the height of the referenced object.

説明

ハンドルで指定した図形の高さを返します。高さとは、3次元図形の高さではなく、Y方向の高さです。

Parameters:

h

Handle to object.

図形のハンドル

返り値

高さ

VectorScript Declaration:

FUNCTION   HLength

( h:HANDLE ) :REAL ;

Python:

def  vs.HLength(h):

   return REAL

Description:

Function HLength returns the length of a line.

説明

ハンドルで指定した図形の長さを返します。

Parameters:

h

Handle to object.

図形のハンドル

返り値

長さ

VectorScript Declaration:

FUNCTION   HPerim

( h:HANDLE ) :REAL ;

Python:

def  vs.HPerim(h):

   return REAL

Description:

Function HPerim returns the perimeter of the referenced object.

説明

ハンドルで指定した図形の周囲の長さを返します。

Parameters:

h

Handle to object.

図形のハンドル

返り値

周囲の長さ

VectorScript Declaration:

FUNCTION   HPerimN

( ObjectHandle:HANDLE ) :REAL ;

Python:

def  vs.HPerimN(ObjectHandle):

   return REAL

Description:

Calculate a perimeter of an object. Same as HPerim(), but it gives more accurate result when the object is a polyline.

説明

ハンドルで指定した図形の周囲の長さを返します。曲線の場合、関数HPerimより正確です。

Example:

perimeter := HPerim(object);

VectorScript Declaration:

FUNCTION   HWidth

( h:HANDLE ) :REAL ;

Python:

def  vs.HWidth(h):

   return REAL

Description:

Function HWidth returns the width of the referenced object.

説明

ハンドルで指定した図形の幅を返します。

Parameters:

h

Handle to object.

図形のハンドル

返り値

図形の幅

Example:

w:=HWidth(HandleToObj); 

VectorScript Declaration:

FUNCTION   IsLocked

( VAR hObject:HANDLE ) :BOOLEAN ;

Python:

def  vs.IsLocked(hObject):

   return (BOOLEAN, hObject)

Description:

Returns is the object locked for edit.

説明

ハンドルで指定したオブジェクトがロックされているかどうかを返します。

Parameters:

hObject

Handle to the object

オブジェクトのハンドル

Result:

Returns is the object locked.

返り値

オブジェクトがロックされているかどうかを返します。

Example:

isLocked := vs.IsLocked( object );

VectorScript Declaration:

FUNCTION   IsResourceReferenced

(   resource :HANDLE;   VAR  pathname :STRING ) :BOOLEAN ;

Python:

def  vs.IsResourceReferenced(resource):

   return (BOOLEAN, pathname)

Description:

Returns whether a resource is workgroup referenced, and if so, the path to the source document is returned.

説明

リソースがファイル参照されているかどうかを返します。参照されている場合は、参照元ファイルのパスを返します。

Parameters:

resource	Handle to the resource	リソースのハンドル
pathname	On return, a string containing the path to the source document	戻り値として、ソース・ドキュメントへのパスを含む文字列が返されます。

Result:

Returns true if the resource is referenced, false otherwise.

返り値

リソースが参照されていればtrueを、そうでなければfalseを返します。

Example:

PROCEDURE DoIt(h :HANDLE);
VAR
    pathname: STRING;
    isref: BOOLEAN;
BEGIN
    isref := IsResourceReferenced(h, pathname);
    IF (isref) THEN Message(pathname);
END;

See Also:

IsLayerReferenced  

VectorScript Declaration:

FUNCTION   ObjArea

( h:HANDLE ) :REAL ;

Python:

def  vs.ObjArea(h):

   return REAL

Description:

Function ObjArea returns the area of the referenced object.

説明

ハンドルで指定した図形の面積を返します。値は「単位の設定」ダイアログで設定されている「面積」の単位になります。

Parameters:

h

Handle to object.

図形のハンドル

VectorScript Declaration:

FUNCTION   ObjAreaN

( ObjectHandle :HANDLE ) :REAL ;

Python:

def  vs.ObjAreaN(ObjectHandle ):

   return REAL

Description:

HObjAreaN, this VS Call is the same as HOBJArea() call but it gives more accurate result when the object is a polyline.

説明

ハンドルで指定した図形の面積を返します。値は「単位の設定」ダイアログで設定されている「面積」の単位になります。曲線の場合、関数ObjAreaより正確です。

Example:

area := HOBJAreaN(object);

VectorScript Declaration:

PROCEDURE   SetAngle

(   h :HANDLE;     value :REAL ) ;

Python:

def  vs.SetAngle(h, value):

   return None

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.	角度の値（度数）

VectorScript Declaration:

PROCEDURE   SetHeight

(   h :HANDLE;     value :REAL ) ;

Python:

def  vs.SetHeight(h, value):

   return None

Description:

Set height of the passed object.

説明

ハンドルで指定した図形の高さを設定します。

Parameters:

h	Handle to object.	図形のハンドル
value	The new height of the object.	高さの値

VectorScript Declaration:

PROCEDURE   SetObjectVariableBoolean

(   h :HANDLE;     index :INTEGER;     status :BOOLEAN ) ;

Python:

def  vs.SetObjectVariableBoolean(h, index, status):

   return None

Description:

Sets the ON-OFF status of a Vectorworks object property.

For specific object selector index values, see the Appendix.

説明

ハンドルで指定した図形の論理（BOOLEAN）値を設定します。

Parameters:

h	Handle to object.	図形のハンドル
index	Object property index.	識別番号
status	New status for property.	設定値

Example:

SetObjectVariableBoolean(17,FALSE);

VectorScript Declaration:

PROCEDURE   SetObjectVariableHandle

(   h :HANDLE;     index :INTEGER;     value :HANDLE ) ;

Python:

def  vs.SetObjectVariableHandle(h, index, value):

   return None

Description:

Sets the value of a Vectorworks object property.

説明

図形プロパティの値を設定します。

VectorScript Declaration:

PROCEDURE   SetObjectVariableInt

(   h :HANDLE;     index :INTEGER;     value :INTEGER ) ;

Python:

def  vs.SetObjectVariableInt(h, index, value):

   return None

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.

説明

ハンドルで指定した図形の整数（INTEGER）値を設定します。

Parameters:

h	Handle to object.	図形のハンドル
index	Object property index.	識別番号
value	New value for property.	設定値

Example:

SetObjectVariableInt(h,1,2);

VectorScript Declaration:

PROCEDURE   SetObjectVariableLongInt

(   h :HANDLE;     index :INTEGER;     value :LONGINT ) ;

Python:

def  vs.SetObjectVariableLongInt(h, index, value):

   return None

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.

説明

ハンドルで指定した図形の整数（LONGINT）値を設定します。

Parameters:

h	Handle to object.	図形のハンドル
index	Object property index.	識別番号
value	New value for property.	設定値

Example:

SetPref(17,FALSE);

VectorScript Declaration:

FUNCTION   SetObjectVariablePoint

(   h :HANDLE;     index :INTEGER;     pX :REAL;     pY :REAL;     pZ :REAL ) :BOOLEAN ;

Python:

def  vs.SetObjectVariablePoint(h, index, p):

   return BOOLEAN

Description:

Sets the value of a Vectorworks object property. Used with properties requiring a 2D or 3D point value.

For specific object selector index values, see the Appendix.

説明

図形の設定値を設定します。2D、3Dの点の設定値で利用します。

Parameters:

h	Handle to object.	図形のハンドル
index	Object property index.	識別番号
p	The object variable data point.	point設定値を設定します。

See Also:

GetObjectVariablePoint   GetObjectVariableBoolean   SetObjectVariableBoolean   GetObjectVariableHandle   SetObjectVariableHandle   GetObjectVariableInt   SetObjectVariableInt   GetObjectVariableLongInt   SetObjectVariableLongInt   GetObjectVariableReal   SetObjectVariableReal   GetObjectVariableString   SetObjectVariableString  

VectorScript Declaration:

PROCEDURE   SetObjectVariableReal

(   h :HANDLE;     index :INTEGER;     value :REAL ) ;

Python:

def  vs.SetObjectVariableReal(h, index, value):

   return None

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.

説明

ハンドルで指定した図形の実数（REAL）値を設定します。

Parameters:

h	Handle to object.	図形のハンドル
index	Object property index.	識別番号
value	New value for property.	設定値

Example:

SetPref(17,FALSE);

VectorScript Declaration:

PROCEDURE   SetObjectVariableString

(   h :HANDLE;     index :INTEGER;     value :DYNARRAY[] of CHAR ) ;

Python:

def  vs.SetObjectVariableString(h, index, value):

   return None

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.

説明

ハンドルで指定した図形の文字列（STRING）を設定します。

Parameters:

h	Handle to object.	図形のハンドル
index	Object property index.	識別番号
value	New value for property.	設定値

Example:

SetPref(17,FALSE);

VectorScript Declaration:

PROCEDURE   SetPlanarRef

(   h :HANDLE;     refID :LONGINT ) ;

Python:

def  vs.SetPlanarRef(h, refID):

   return None

Description:

Set the plane ref ID of the specified object.

説明

指定した図形の平面参照番号を設定します。

Parameters:

h	Handle to the object.	図形のハンドル
refID	Reference ID of the plane.	平面参照番号

VectorScript Declaration:

PROCEDURE   SetPlanarRefIDToGround

( h:HANDLE ) ;

Python:

def  vs.SetPlanarRefIDToGround(h):

   return None

Description:

Set the specified object on the ground plane. This function is to be used inside parametric objects to place objects on the local coordinate system's ground of the parametric.

説明

指定した図形を基準平面上に設定します。パラメトリックオブジェクトの中で使用します。

Parameters:

h

Handle to the object.

図形のハンドル

VectorScript Declaration:

PROCEDURE   SetWidth

(   h :HANDLE;     value :REAL ) ;

Python:

def  vs.SetWidth(h, value):

   return None

Description:

Set width of the passed object.

説明

ハンドルで指定した図形の幅を設定します。

Parameters:

h	Handle to object.	図形のハンドル
value	The new width of the object.	幅の値