Object Attributes

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION AddSubMtrlToMtrl

( hMaterial :HANDLE;

subMtrlName :STRING;

fraction :REAL;

makePrimary :BOOLEAN

) :Boolean ;

Python:

def vs.AddSubMtrlToMtrl(hMaterial, subMtrlName, fraction, makePrimary):
return Boolean

Description:

Adds a Simple material to a Compound material. Sets the fraction of the Simple material as a relation to the whole. Fraction can have value between 0.0 and 1.0. "Primary" material is a simple material which carries the graphical attributes to be used by the compound material.

説明

シンプルマテリアルを複合マテリアルに追加します。複合マテリアル全体に対するシンプルマテリアルの割合を設定します。割合は0.0から1.0の間で指定します。「Primary」（メイン）マテリアルとは、複合マテリアルにおいてグラフィック属性を扱うシンプルマテリアルのことです。

Parameters:

hMaterial Handle of a Compound material 複合マテリアルのハンドル

subMtrlName Name of a Simple material to be added 追加するシンプルマテリアルの名前

fraction Fraction of the Simple material シンプルマテリアルの割合

makePrimary True if this Simple material should become the primary material of the Compound material このシンプルマテリアルを複合マテリアルのメインマテリアルにする場合にTRUEにします。

Result:

Returns true if successful; false otherwise. Function fails if the simple material already was added.

返り値

成功すると、TRUEを返します。すでにシンプルマテリアルでなかった場合にはFALSEを返します。

CountFillSpaces

Object Attributes
Vectorworks 2018

VectorScript Declaration:

FUNCTION CountFillSpaces

( h:HANDLE ) :INTEGER ;

Python:

def vs.CountFillSpaces(h):
return INTEGER

Description:

Returns the number of fill spaces currently attached to a specified object.

説明

指定したオブジェクトのauxリストにあるフィル空間の数を返します。

Parameters:

h Handle to the object containing the fill spaces to be counted. オブジェクトのハンドル

Result:

The number of fill spaces attached to the object h.

返り値

指定したオブジェクトに付与されているフィル空間の数を返します。

CreateFillSpace

Object Attributes
Vectorworks 2018

VectorScript Declaration:

FUNCTION CreateFillSpace

( owner:HANDLE ) :HANDLE ;

Python:

def vs.CreateFillSpace(owner):
return HANDLE

Description:

Creates a new fillspace object and attaches it to the end of the aux list of the specified object.

説明

新しいフィル空間オブジェクトを作成して、指定したオブジェクトのauxリストの最後に追加します。

Parameters:

owner Handle to the object in whose aux list the fill space will be created. オブエクトのハンドル

Result:

Handle to the newly created fill space object.

返り値

新しく作成されたフィル空間のハンドルを返します。

CreateMaterial

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION CreateMaterial

( name :STRING;

isSimpleMaterial :BOOLEAN

) :HANDLE ;

Python:

def vs.CreateMaterial(name, isSimpleMaterial):
return HANDLE

説明

指定したシンプル、または複合タイプのBuildingMaterialTypeノードを作成します。ノードのタイプは作成後に変更することはできません。

EnableDropShadow

Object Attributes
Vectorworks 2017

VectorScript Declaration:

PROCEDURE EnableDropShadow

( h :HANDLE;

enable :BOOLEAN

) ;

Python:

def vs.EnableDropShadow(h, enable):
return None

GetClass

Object Attributes
MiniCAD

VectorScript Declaration:

FUNCTION GetClass

( h:HANDLE ) :STRING ;

Python:

def vs.GetClass(h):
return STRING

Description:

Function GetClass returns the class assigned to the referenced object. None is returned if the object has no class assigned to it.

説明

ハンドルで指定した図形のクラスの名前を返します。

Parameters:

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

Example:
ObjectClass:=GetClass(handleToObject);

GetDescriptionText

Object Attributes
Vectorworks 2015

VectorScript Declaration:

PROCEDURE GetDescriptionText

( hObject :HANDLE;

VAR descriptionText :DYNARRAY[] of CHAR

) ;

Python:

def vs.GetDescriptionText(hObject):
return descriptionText

Description:

Retrieves any description text that exists for a specified object and passes it back in the descriptionText argument. The descriptionText argument will be empty if the object has no description text.

説明

指定した図形に設定された任意の説明文を返します。説明文字が設定されていない場合、”descriptionText”は空になります。

Parameters:

hObject Handle of object for which to retrieve the text. 図形のハンドル

descriptionText Object's description text, if any exists. 図形の説明文

Example:
PROCEDURE GetDescExample;
VAR
	descriptionTextDyn	:DYNARRAY [] of CHAR;
	tempH : HANDLE;
BEGIN
	tempH := GetObject ('Dimension');

	GetDescriptionText (tempH, descriptionTextDyn);

	IF descriptionTextDyn <> ''  THEN 
		Message (descriptionTextDyn)
	ELSE
		Message ('no description');
END;
Run (GetDescExample);
See Also:

SetDescriptionText

GetDropShadowByCls

Object Attributes
Vectorworks 2017

VectorScript Declaration:

FUNCTION GetDropShadowByCls

( H:HANDLE ) :BOOLEAN ;

Python:

def vs.GetDropShadowByCls(H):
return BOOLEAN

GetDropShadowData

Object Attributes
Vectorworks 2017

VectorScript Declaration:

FUNCTION GetDropShadowData

( h :HANDLE;

VAR nUnits :INTEGER;

VAR dOffset :REAL;

VAR dBlurRadius :REAL;

VAR dAngle :REAL;

VAR nOpacity :INTEGER;

VAR colorRV :INTEGER;

VAR colorGV :INTEGER;

VAR colorBV :INTEGER

) :BOOLEAN ;

Python:

def vs.GetDropShadowData(h):
return (BOOLEAN, nUnits, dOffset, dBlurRadius, dAngle, nOpacity, colorRV, colorGV, colorBV)

GetEntityMatrix

Object Attributes
Vectorworks 2011

VectorScript Declaration:

FUNCTION GetEntityMatrix

( objectHandle :HANDLE;

VAR offsetX :REAL;

VAR offsetY :REAL;

VAR offsetZ :REAL;

VAR rotationXAngle :REAL;

VAR rotationYAngle :REAL;

VAR rotationZAngle :REAL

) :BOOLEAN ;

Python:

def vs.GetEntityMatrix(objectHandle):
return (BOOLEAN, offset, rotationXAngle, rotationYAngle, rotationZAngle)

Description:

Gets the matrix of the plane for a planar object.

説明

プレイナー図形の平面マトリックスを取得します。

Parameters:

objectHandle The object for which the matrix of its plane is being obtained. マトリックスを取得したいオブジェクト

offset The offset of the plane in current document units. 現在の書類の単位での平面のオフセット

rotationXAngle The rotation of the plane about the X-axis in degrees. X軸周りの平面の回転角度

rotationYAngle The rotation of the plane about the Y-axis in degrees. Y軸周りの平面の回転角度

rotationZAngle The rotation of the plane about the Z-axis in degrees. Z軸周りの平面の回転角度

Result:

Returns true if the object passed is a planar object.

返り値

渡されたオブジェクトがプレイナー図形の場合にはtrueを返します。

GetFillBack

Object Attributes
MiniCAD6.0

VectorScript Declaration:

PROCEDURE GetFillBack

( h :HANDLE;

VAR red :LONGINT;

VAR green :LONGINT;

VAR blue :LONGINT

) ;

Python:

def vs.GetFillBack(h):
return (red, green, blue)

Description:

Procedure GetFillBack returns the fill background color of the referenced object. RGB values are in the range of 0~65535.

説明

ハンドルで指定した図形の面の地色の成分を返します。値の範囲は0から65535までです。

Parameters:

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

red Returns RGB color component value. 赤の成分

green Returns RGB color component value. 緑の成分

blue Returns RGB color component value. 青の成分

Example:
GetFillBack(handleToObject,redValue,greenValue,blueValue);
See Also:

RGBToColorIndex ColorIndexToRGB

GetFillFore

Object Attributes
MiniCAD6.0

VectorScript Declaration:

PROCEDURE GetFillFore

( h :HANDLE;

VAR red :LONGINT;

VAR green :LONGINT;

VAR blue :LONGINT

) ;

Python:

def vs.GetFillFore(h):
return (red, green, blue)

Description:

Procedure GetFillFore returns the fill foreground color of the referenced object. RGB values are in the range of 0~65535.

説明

ハンドルで指定した図形の面の色成分を返します。値の範囲は0から65535までです。

Parameters:

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

red Returns RGB color component value. 赤の成分

green Returns RGB color component value. 緑の成分

blue Returns RGB color component value. 青の成分

Example:
GetFillFore(handleToObject,redValue,greenValue,blueValue);
See Also:

RGBToColorIndex ColorIndexToRGB

GetFillIAxisEndPoint

Object Attributes
VectorWorks10.0

VectorScript Declaration:

PROCEDURE GetFillIAxisEndPoint

( objectHandle :HANDLE;

VAR xIAxisEndPoint :REAL;

VAR yIAxisEndPoint :REAL

) ;

Python:

def vs.GetFillIAxisEndPoint(objectHandle):
return (xIAxisEndPoint, yIAxisEndPoint)

Description:

Gets the I-axis end point of the fill.

Note: only works with 2D objects that have a gradient or image fill.

説明

I軸の終点座標を返します。

注：グラデーションやイメージ属性をもつ2次元図形でのみ利用できます。

Parameters:

objectHandle Handle to the object with fill. 図形のハンドル

xIAxisEndPoint X coordinate of I-axis point. I軸終点のX座標

yIAxisEndPoint Y coordinate of I-axis point. I軸終点のY座標

Example:
GetFillIAxisEndPoint(objectHandle, xIAxis, yIAxis);

GetFillJAxisEndPoint

Object Attributes
VectorWorks10.0

VectorScript Declaration:

PROCEDURE GetFillJAxisEndPoint

( objectHandle :HANDLE;

VAR xJAxisEndPoint :REAL;

VAR yJAxisEndPoint :REAL

) ;

Python:

def vs.GetFillJAxisEndPoint(objectHandle):
return (xJAxisEndPoint, yJAxisEndPoint)

Description:

Gets the J-axis end point of the fill.

Note: only works with 2D objects that have a gradient or image fill.

説明

J軸の終点座標を返します。

注：グラデーションやイメージ属性をもつ2次元図形でのみ利用できます。

Parameters:

objectHandle Handle to the object with fill. 図形のハンドル

xJAxisEndPoint X coordinate of J-axis point. J軸終点のX座標

yJAxisEndPoint Y coordinate of J-axis point. J軸終点のY座標

Example:
GetFillJAxisEndPoint(objectHandle, xJAxis, yJAxis);

GetFillOriginPoint

Object Attributes
VectorWorks10.0

VectorScript Declaration:

PROCEDURE GetFillOriginPoint

( objectHandle :HANDLE;

VAR xOriginPoint :REAL;

VAR yOriginPoint :REAL

) ;

Python:

def vs.GetFillOriginPoint(objectHandle):
return (xOriginPoint, yOriginPoint)

Description:

Gets the origin point of the fill.

Note: only works with 2D objects that have a gradient or image fill.

説明

原点座標を返します。

注：グラデーションやイメージ属性をもつ2次元図形でのみ利用できます。

Parameters:

objectHandle Handle to the object with fill. 図形のハンドル

xOriginPoint X coordinate of origin point. 原点のX座標

yOriginPoint Y coordinate of origin point. 原点のY座標

Example:
GetFillOriginPoint(objectHandle, xOrigin, yOrigin);

GetFillPoints

Object Attributes
VectorWorks10.0

VectorScript Declaration:

PROCEDURE GetFillPoints

( objectHandle :HANDLE;

VAR xOriginPoint :REAL;

VAR yOriginPoint :REAL;

VAR xIAxisEndPoint :REAL;

VAR yIAxisEndPoint :REAL;

VAR xJAxisEndPoint :REAL;

VAR yJAxisEndPoint :REAL

) ;

Python:

def vs.GetFillPoints(objectHandle):
return (xOriginPoint, yOriginPoint, xIAxisEndPoint, yIAxisEndPoint, xJAxisEndPoint, yJAxisEndPoint)

Description:

Gets start and axis end points of the fill.

Note: only works with 2D objects that have a gradient or image fill.

説明

原点やI、J軸の終点座標を返します。

注：グラデーションやイメージ属性をもつ2次元図形でのみ利用できます。

Parameters:

objectHandle Handle to the object with fill. 図形のハンドル

xOriginPoint X coordinate of origin point. 原点のX座標

yOriginPoint Y coordinate of origin point. 原点のY座標

xIAxisEndPoint X coordinate of I-axis point. I軸終点のX座標

yIAxisEndPoint Y coordinate of I-axis point. I軸終点のY座標

xJAxisEndPoint X coordinate of J-axis point. J軸終点のX座標

yJAxisEndPoint Y coordinate of J-axis point. J軸終点のY座標

Example:
GetFillPoints(objectHandle, xOrigin, yOrigin, xIAxis, yIAxis, xJAxis, yJAxis);

GetFillSpace

Object Attributes
Vectorworks 2018

VectorScript Declaration:

FUNCTION GetFillSpace

( h :HANDLE;

index :INTEGER

) :HANDLE ;

Python:

def vs.GetFillSpace(h, index):
return HANDLE

Description:

Returns the handle of the index-th fill space in the specified object's aux list.

説明

指定したオブジェクトのauxリストの、n番目のフィル空間のハンドルを返します。

Parameters:

h Handle to the object containing the fill space. オブジェクトのハンドル

index Index of the fill space to be returned. フィル空間のインデックス

Result:

Handle to the index-th fill space in h's aux list.

返り値

auxリストの指定したインデックスのフィル空間を返します。

GetFPat

Object Attributes
MiniCAD

VectorScript Declaration:

FUNCTION GetFPat

( h:HANDLE ) :LONGINT ;

Python:

def vs.GetFPat(h):
return LONGINT

Description:

Function GetFPat returns the fill pattern of the referenced object.

A positive value corresponds to the index of the fill pattern on the pattern palette. A negative value corresponds to internal index of a vector fill pattern applied to the object.

Fill patterns and their associated constants can be found in the VectorScript Appendix.

説明

ハンドルで指定した図形の面の模様番号を返します。

ビットマップは0から71までの正の値で示されています。ハッチングは負の値で示されています。

Parameters:

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

Example:
FPatValue:=GetFPat(HandleToObj);

GetLS

Object Attributes
MiniCAD - obsolete as of Vectorworks 2013

VectorScript Declaration:

FUNCTION GetLS

( h:HANDLE ) :INTEGER ;

Python:

def vs.GetLS(h):
return INTEGER

Special Notes:

GetLS is obsolete as of Vectorworks 2013

Description:

Deprecated - will generate error. Use GetLSN instead.

説明

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

Parameters:

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

Example:
lStyleValue:=GetLS(handleToObject);
See Also:

GetLSN

GetLSN

Object Attributes
Vectorworks 2013

VectorScript Declaration:

FUNCTION   GetLSN

( h:HANDLE ) :LONGINT ;

Python:

def  vs.GetLSN(h):
return LONGINT

Description:

Function GetLSN returns the line style of the referenced object.

説明

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

Parameters:

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

See Also:

SetLSN

GetLW

Object Attributes
MiniCAD

VectorScript Declaration:

FUNCTION GetLW

( h:HANDLE ) :INTEGER ;

Python:

def vs.GetLW(h):
return INTEGER

Description:

Function GetLW returns the line weight of the referenced object. The value returned represents the width in mils.

説明

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

Parameters:

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

Example:
PROCEDURE GetLWExample;
VAR
	x, y :REAL;
	h :HANDLE;
BEGIN
	GetPt(x, y);
	h := PickObject(x, y);
	IF h <> NIL THEN Message(GetLW(h));
END;
RUN(GetLWExample);

GetMarker

Object Attributes
VectorWorks10.0 - obsolete as of VectorWorks 2008

VectorScript Declaration:

PROCEDURE GetMarker

( h :HANDLE;

VAR start :BOOLEAN;

VAR end :BOOLEAN;

VAR style :INTEGER;

VAR size :REAL

) ;

Python:

def vs.GetMarker(h):
return (start, end, style, size)

Special Notes:

GetMarker is obsolete as of VectorWorks 2008

Description:

Returns marker information on the referenced object.

説明

ハンドルで指定した図形のマーカ情報を返します。

VW2008で使用できなくなった関数／手続きです。
GetObjBeginningMarker、GetObjEndMarkerをご利用ください。

Parameters:

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

start True if a marker is visible at start of object. 始点にマーカがある場合はTRUE

end True if a marker is visible at end of object. 終点にマーカがある場合はTRUE

style Marker style: 0 - Filled Arrow Marker 1 - Empty Arrow Marker 2 - Open Arrow Marker 3 - Filled Ball Marker 4 - Empty Ball Marker 5 - Slash Marker 6 - Cross Marker スタイル

size Size of marker. 長さ（インチ）

Example:
PROCEDURE CheckMarker;
VAR
	h: HANDLE;
	MarkerStyle: INTEGER;
	StartMark, EndMark: BOOLEAN;
	Size: REAL;
BEGIN
	h := FSActLayer;
	GetMarker(H, StartMark, EndMark, MarkerStyle, Size);
	Message('StartMark: ', StartMark, ' EndMark:', EndMark, ' MarkerStyle:', MarkerStyle, ' Size:', Size);
END;
RUN(CheckMarker);
See Also:

SetMarker

GetMaterialArea

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION   GetMaterialArea

( h :HANDLE;

material :STRING

) :REAL ;

Python:

def  vs.GetMaterialArea(h, material):
return REAL

Description:

Returns the surface area of the object having the specified material.

説明

指定したマテリアルを使用しているオブジェクトの表面積を返します。

Parameters:

h Handle to object. オブジェクトのハンドル

material Name of material. マテリアルの名前

Result:

Returns the surface area of the object having the specified material.

返り値

指定したマテリアルを使用しているオブジェクトの表面積を返します。

See Also:

GetMaterialVolume

GetMaterialFillStyle

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION GetMaterialFillStyle

( materialHandle:HANDLE ) :LONGINT ;

Python:

def vs.GetMaterialFillStyle(materialHandle):
return LONGINT

GetMaterialTexture

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION GetMaterialTexture

( objectHandle:HANDLE ) :LONGINT ;

Python:

def vs.GetMaterialTexture(objectHandle):
return LONGINT

GetMaterialVolume

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION GetMaterialVolume

( h :HANDLE;

material :STRING

) :REAL ;

Python:

def vs.GetMaterialVolume(h, material):
return REAL

Description:

Returns the volume of the object having the specified material.

説明

指定したマテリアルを使用しているオブジェクトの体積を返します。

Parameters:

h Handle to the object. オブジェクトのハンドル

material Returns the volume of the object having the specified material. 指定したマテリアルを使用しているオブジェクトの体積を返します。

Result:

Returns the volume of the object having the specified material.

返り値

指定したマテリアルを使用しているオブジェクトの体積を返します。

GetMtlFillBackColor

Object Attributes
Vectorworks 2021

VectorScript Declaration:

PROCEDURE GetMtlFillBackColor

( material :HANDLE;

VAR red :LONGINT;

VAR green :LONGINT;

VAR blue :LONGINT

) ;

Python:

def vs.GetMtlFillBackColor(material):
return (red, green, blue)

Description:

Returns the fill background color of the specified material. The color is returned as the RGB components of the color. RGB values are in the range of 0~65535.

説明

指定したマテリアルの背景色をRGB値で返します。値の範囲は0から65535までです。

Parameters:

material Handle to material. マテリアルのハンドル

red Returns RGB color component (red). 赤の成分

green Returns RGB color component (green). 緑の成分

blue Returns RGB color component (blue). 青の成分

Example:
GetMtlFillBackColor(mtlHandle,cRed,cGrn,cBlu);
RGBToColorIndex(cRed,cGrn,cBlu,colorValue);

GetMtlFillForeColor

Object Attributes
Vectorworks 2021

VectorScript Declaration:

PROCEDURE GetMtlFillForeColor

( material :HANDLE;

VAR red :LONGINT;

VAR green :LONGINT;

VAR blue :LONGINT

) ;

Python:

def vs.GetMtlFillForeColor(material):
return (red, green, blue)

Description:

Returns the fill foreground color of the specified material. The color is returned as the RGB components of the color. RGB values are in the range of 0~65535.

説明

指定したマテリアルの前景色をRGB値で返します。値の範囲は0から65535までです。

Parameters:

material Handle to material. マテリアルのハンドル

red Returns RGB color component (red). 赤の成分

green Returns RGB color component (green). 緑の成分

blue Returns RGB color component (blue). 青の成分

Example:
GetMtlFillForeColor(mtlHandle,cRed,cGrn,cBlu);
RGBToColorIndex(cRed,cGrn,cBlu,colorValue);

GetMtlPenBackColor

Object Attributes
Vectorworks 2021 - obsolete as of Vectorworks 2022

VectorScript Declaration:

PROCEDURE GetMtlPenBackColor

( material :HANDLE;

VAR red :LONGINT;

VAR green :LONGINT;

VAR blue :LONGINT

) ;

Python:

def vs.GetMtlPenBackColor(material):
return (red, green, blue)

Special Notes:

GetMtlPenBackColor is obsolete as of Vectorworks 2022

Description:

Deprecated - will generate error.

説明

指定したマテリアルの線の背景色をRGB値で返します。値の範囲は0から65535までです。

Parameters:

material Handle to material. マテリアルのハンドル

red Returns RGB color component (red). 赤の成分

green Returns RGB color component (green). 緑の成分

blue Returns RGB color component (blue). 青の成分

Example:
GetMtlPenBackColor(mtlHandle,cRed,cGrn,cBlu);
RGBToColorIndex(cRed,cGrn,cBlu,colorValue);

GetMtlPenForeColor

Object Attributes
Vectorworks 2021 - obsolete as of Vectorworks 2022

VectorScript Declaration:

PROCEDURE GetMtlPenForeColor

( material :HANDLE;

VAR red :LONGINT;

VAR green :LONGINT;

VAR blue :LONGINT

) ;

Python:

def vs.GetMtlPenForeColor(material):
return (red, green, blue)

Special Notes:

GetMtlPenForeColor is obsolete as of Vectorworks 2022

Description:

Deprecated - will generate error.

説明

指定したマテリアルの線の前景色をRGB値で返します。値の範囲は0から65535までです。

Parameters:

material Handle to material. マテリアルのハンドル

red Returns RGB color component (red). 赤の成分

green Returns RGB color component (green). 緑の成分

blue Returns RGB color component (blue). 青の成分

Example:
GetMtlPenForeColor(mtlHandle,cRed,cGrn,cBlu);
RGBToColorIndex(cRed,cGrn,cBlu,colorValue);

GetObjArrow

Object Attributes
VectorWorks10.0 - obsolete as of VectorWorks 2008

VectorScript Declaration:

PROCEDURE GetObjArrow

( obj :HANDLE;

VAR style :INTEGER;

VAR size :REAL;

VAR angle :INTEGER;

VAR start :BOOLEAN;

VAR end :BOOLEAN

) ;

Python:

def vs.GetObjArrow(obj):
return (style, size, angle, start, end)

Special Notes:

GetObjArrow is obsolete as of VectorWorks 2008

Description:

Procedure GetObjArrow returns the arrow style parameters for the indicated object.

説明

ハンドルで指定した図形のマーカスタイルを返します。

VW2008で使用できなくなった関数／手続きです。
GetObjBeginningMarker、GetObjEndMarkerをご利用ください。

Parameters:

obj The indicated object. 図形のハンドル

style Returns arrow style. スタイル

size Returns arrow size in inches measured in page space. 長さ（インチ）

angle Returns arrow angle (in degrees). 角度（度）

start Returns whether the start point of the object has an arrow. 始点にマーカがある場合はTRUE

end Returns whether the endpoint of the object has an arrow. 終点にマーカがある場合はTRUE

Example:
PROCEDURE ShowObjArrowValues;
VAR
	style :INTEGER;
	size	 :REAL;
	ang	 :INTEGER;
	start :BOOLEAN;
	endPt :BOOLEAN;
	obj   :HANDLE;
BEGIN
	obj := FSActLayer;
	GetObjArrow(obj, style, size, ang, start, endPt);
	Message(style, ' ', size, ' ', ang, ' ', start, ' ', endPt);
END;
RUN(ShowObjArrowValues);

GetObjBeginningMarker

Object Attributes
VectorWorks 2008

VectorScript Declaration:

FUNCTION GetObjBeginningMarker

( object :HANDLE;

VAR style :LONGINT;

VAR angle :INTEGER;

VAR size :REAL;

VAR width :REAL;

VAR thicknessBasis :INTEGER;

VAR thickness :REAL;

VAR visibility :BOOLEAN

) :BOOLEAN ;

Python:

def vs.GetObjBeginningMarker(object):
return (BOOLEAN, style, angle, size, width, thicknessBasis, thickness, visibility)

Description:

Gets all properties for an object's beginning marker. Return TRUE if operation was successful.

説明

ハンドルで指定した図形の始点マーカのすべての設定値を返します。正常終了するとTRUEが返されます。

Parameters:

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

style The marker style. (see comments for details) タイプ

angle The marker angle in degrees. (0 to 90) 角度（度数、0から90）

size The marker size in inches. 高さ（インチ）

width The marker width in inches. 幅（インチ）

thicknessBasis The marker thickness basis. ( see comments for details) 太さ

thickness The marker thickness. カスタム設定の太さ

visibility The marker visibility. 表示／非表示

Example:
PROCEDURE Example;
VAR
	h: HANDLE;
	style: INTEGER;
	angle: INTEGER;
	size: REAL;
	width: REAL;
	thickBasis: INTEGER;
	thickness: REAL;
	visibility: BOOLEAN;

	ok : BOOLEAN;
	
BEGIN
	h := FSActLayer;
	ok := GetObjBeginningMarker (h, style, angle, size, width, thickBasis, thickness, visibility);
	Message (style, ' /  ', angle, '  /  ', size, '  /  ', width, ' /  ', thickBasis, ' /  ', thickness, ' /  ', visibility);
END;

RUN(Example);
See Also:

GetObjEndMarker

GetObjEndMarker

Object Attributes
VectorWorks 2008

VectorScript Declaration:

FUNCTION GetObjEndMarker

( object :HANDLE;

VAR style :LONGINT;

VAR angle :INTEGER;

VAR size :REAL;

VAR width :REAL;

VAR thicknessBasis :INTEGER;

VAR thickness :REAL;

VAR visibility :BOOLEAN

) :BOOLEAN ;

Python:

def vs.GetObjEndMarker(object):
return (BOOLEAN, style, angle, size, width, thicknessBasis, thickness, visibility)

Description:

Gets all properties for an object's end marker. Return TRUE if operation was successful.

説明

ハンドルで指定した図形の終点マーカのすべての設定値を返します。正常終了するとTRUEが返されます。

Parameters:

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

style The marker style. (see comments for details) タイプ

angle The marker angle in degrees. (0 to 90) 角度（度数、0から90）

size The marker size in page inches. 長さ（インチ）

width The marker width in page inches. 幅（インチ）

thicknessBasis The marker thickness basis. ( see comments for details) 太さ

thickness The marker thickness. カスタム設定の太さ

visibility The marker visibility. 表示／非表示

Example:
PROCEDURE Example;
VAR
	h: HANDLE;
	style: INTEGER;
	angle: INTEGER;
	size: REAL;
	width: REAL;
	thickBasis: INTEGER;
	thickness: REAL;
	visibility: BOOLEAN;

	ok : BOOLEAN;
	
BEGIN
	h := FSActLayer;
	ok := GetObjEndMarker (h, style, angle, size, width, thickBasis, thickness, visibility);
	Message (style, ' /  ', angle, '  /  ', size, '  /  ', width, ' /  ', thickBasis, ' /  ', thickness, ' /  ', visibility);
END;

RUN(Example);
See Also:

GetObjBeginningMarker

GetObjMaterialHandle

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION GetObjMaterialHandle

( h:HANDLE ) :HANDLE ;

Python:

def vs.GetObjMaterialHandle(h):
return HANDLE

説明

オブジェクトが使用しているマテリアルのハンドルを返します。

Parameters:

h object handle オブジェクトのハンドル

GetObjMaterialName

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION GetObjMaterialName

( h :HANDLE;

VAR materialName :STRING

) :BOOLEAN ;

Python:

def vs.GetObjMaterialName(h):
return (BOOLEAN, materialName)

説明

指定したオブジェクトが使用しているマテリアルの名前を返します。成功するとTRUEを返します。

GetObjTypeProperties

Object Attributes
Vectorworks 2018

VectorScript Declaration:

FUNCTION GetObjTypeProperties

( ObjectType:INTEGER ) :INTEGER ;

Python:

def vs.GetObjTypeProperties(ObjectType):
return INTEGER

Description:

Receives an object type and returns the properties of that object type

説明

オブジェクトタイプを受け取って、そのオブジェクトタイプのプロパティを返します。

Parameters:

ObjectType Object type whose properties are desired オブジェクトのタイプ

Result:

Returns bit map of properties associated with an object's type

返り値

オブジェクトに関連付けられたプロパティのビットマップを返します。

Example:
This function should return kTermProp for type kTermNode, kLineProp for kLineNode and so on for all existing object types that are defined in Objs.TDType.h.

GetOpacity

Object Attributes
VectorWorks 2008

VectorScript Declaration:

PROCEDURE GetOpacity

( h :HANDLE;

VAR opacity :INTEGER

) ;

Python:

def vs.GetOpacity(h):
return opacity

Description:

Gets the opacity of and object. Opacity is obtained as percentage value in range [0-100].

説明

ハンドルで指定した図形の不透明度を返します。

Parameters:

h The object which opacity will be get. 図形のハンドル

opacity Output parameter. Return the object's opacity as percentage value in range [0-100]. 図形の不透明度を、0から100までの値で返します。

GetOpacityByClass

Object Attributes
VectorWorks 2008

VectorScript Declaration:

PROCEDURE GetOpacityByClass

( h :HANDLE;

VAR isByClass :BOOLEAN

) ;

Python:

def vs.GetOpacityByClass(h):
return isByClass

Description:

Returns whether the object is using the class opacity.

説明

ハンドルで指定した図形がクラスの不透明度を使用しているかどうかを返します。

GetOpacityByClassN

Object Attributes
Vectorworks 2017

VectorScript Declaration:

PROCEDURE GetOpacityByClassN

( h :HANDLE;

VAR isPenOpacityByClass :BOOLEAN;

VAR isFillOpacityByClass :BOOLEAN

) ;

Python:

def vs.GetOpacityByClassN(h):
return (isPenOpacityByClass, isFillOpacityByClass)

GetOpacityN

Object Attributes
Vectorworks 2017

VectorScript Declaration:

FUNCTION GetOpacityN

( h :HANDLE;

VAR outPenOpacity :INTEGER;

VAR outFillOpacity :INTEGER

) :Boolean ;

Python:

def vs.GetOpacityN(h):
return (Boolean, outPenOpacity, outFillOpacity)

Parameters:

h Object handle to get the opacity values. 図形のハンドル

outPenOpacity Output parameter. Return the object's pen opacity as percentage value in range [0-100]. 線の不透明度 (0-100%)

outFillOpacity Output parameter. Return the object's fill opacity as percentage value in range [0-100]. 面の不透明度 (0-100%)

GetPenBack

Object Attributes
MiniCAD6.0

VectorScript Declaration:

PROCEDURE GetPenBack

( h :HANDLE;

VAR red :LONGINT;

VAR green :LONGINT;

VAR blue :LONGINT

) ;

Python:

def vs.GetPenBack(h):
return (red, green, blue)

Description:

Procedure GetPenBack returns the pen background color of the referenced object. RGB values are in the range of 0~65535.

説明

ハンドルで指定した図形の線の地色の成分を返します。値の範囲は0から65535までです。

Parameters:

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

red Returns RGB color component value. 赤の成分

green Returns RGB color component value. 緑の成分

blue Returns RGB color component value. 青の成分

Example:
PROCEDURE Example;
VAR
	h :HANDLE;
	r, g, b :LONGINT;
BEGIN
	h := FSActLayer;
	GetPenBack(h, r, g, b);
	Message('r= ', r, ' g= ', g, ' b= ', b);
END;
RUN(Example);
See Also:

RGBToColorIndex ColorIndexToRGB

GetPenFore

Object Attributes
MiniCAD6.0

VectorScript Declaration:

PROCEDURE GetPenFore

( h :HANDLE;

VAR red :LONGINT;

VAR green :LONGINT;

VAR blue :LONGINT

) ;

Python:

def vs.GetPenFore(h):
return (red, green, blue)

Description:

Procedure GetPenFore returns the pen foreground color components of the referenced object. RGB values are in the range of 0~65535.

説明

ハンドルで指定した図形の線の色成分を返します。値の範囲は0から65535までです。

Parameters:

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

red Returns RGB color component value. 赤の成分

green Returns RGB color component value. 緑の成分

blue Returns RGB color component value. 青の成分

Example:
GetPenFore(handleToObject,redValue,greenValue,blueValue);
See Also:

ColorIndexToRGB RGBToColorIndex

GetViewMatrix

Object Attributes
VectorWorks10.5

VectorScript Declaration:

FUNCTION GetViewMatrix

( objectHandle :HANDLE;

VAR offsetX :REAL;

VAR offsetY :REAL;

VAR offsetZ :REAL;

VAR rotationXAng :REAL;

VAR rotationYAng :REAL;

VAR rotationZAng :REAL

) :BOOLEAN ;

Python:

def vs.GetViewMatrix(objectHandle):
return (BOOLEAN, offset, rotationXAng, rotationYAng, rotationZAng)

Description:

Gets view matrix for layer or viewport object.

説明

レイヤやビューポートの見る方向を返します。

HideSelectedObjects

Object Attributes
Vectorworks 2025

VectorScript Declaration:

PROCEDURE HideSelectedObjects

;

Python:

def vs.HideSelectedObjects():
return None

Description:

Sets the object visibility of all selected objects to "invisible". Hidden objects can be made visible with Show or UnHideObjects commands.

説明

選択されているすべてのオブジェクトを非表示にします。非表示になったオブジェクトは、ShowまたはUnHideObjectsを使って表示状態に戻せます。

Example:
HideSelectedObjects();

IsDropShadowEnabled

Object Attributes
Vectorworks 2017

VectorScript Declaration:

FUNCTION IsDropShadowEnabled

( h:HANDLE ) :BOOLEAN ;

Python:

def vs.IsDropShadowEnabled(h):
return BOOLEAN

IsFillColorByClass

Object Attributes
VectorWorks8.0

VectorScript Declaration:

FUNCTION IsFillColorByClass

( h:HANDLE ) :BOOLEAN ;

Python:

def vs.IsFillColorByClass(h):
return BOOLEAN

Description:

Function IsFillColorByClass returns whether class fill colors are used for the referenced object.

説明

ハンドルで指定した図形の面の色が、クラス属性を使用していた場合はTRUEを返します。

Parameters:

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

返り値

クラス属性を使用していた場合はTRUE

IsFPatByClass

Object Attributes
VectorWorks8.0

VectorScript Declaration:

FUNCTION IsFPatByClass

( h:HANDLE ) :BOOLEAN ;

Python:

def vs.IsFPatByClass(h):
return BOOLEAN

Description:

Function IsFPatByClass whether a class fill pattern is used for the referenced object.

説明

ハンドルで指定した図形の面の模様が、クラス属性を使用していた場合はTRUEを返します。

Parameters:

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

返り値

クラス属性を使用していた場合はTRUE

IsLSByClass

Object Attributes
VectorWorks8.0

VectorScript Declaration:

FUNCTION IsLSByClass

( h:HANDLE ) :BOOLEAN ;

Python:

def vs.IsLSByClass(h):
return BOOLEAN

Description:

Function IsLSByClass returns whether a class line style is used for the referenced object.

説明

ハンドルで指定した図形の線の種類が、クラス属性を使用していた場合はTRUEを返します。

Parameters:

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

返り値

クラス属性を使用していた場合はTRUE

IsLWByClass

Object Attributes
VectorWorks8.0

VectorScript Declaration:

FUNCTION IsLWByClass

( h:HANDLE ) :BOOLEAN ;

Python:

def vs.IsLWByClass(h):
return BOOLEAN

Description:

Function IsLWByClass returns whether a class line weight is used for the referenced object.

説明

ハンドルで指定した図形の線の太さが、クラス属性を使用していた場合はTRUEを返します。

Parameters:

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

返り値

クラス属性を使用していた場合はTRUE

Example:
PROCEDURE Example;
VAR
   symDefHandle, h :HANDLE;

PROCEDURE AlertMe;
BEGIN
   Message(GetSDName(symDefHandle));
   SetSelect(h);
END;

BEGIN
   DSelectAll;
   ClrMessage;
   symDefHandle := FSymDef;
   WHILE symDefHandle <> NIL DO BEGIN
      h := FInSymDef(symDefHandle);
      WHILE h <> NIL DO BEGIN
         IF IsLWByClass(h) THEN AlertMe;
         h := NextObj(h);
      END;
      symDefHandle := NextObj(symDefHandle);
   END;
END;
RUN(Example);

IsMarkerByClass

Object Attributes
VectorWorks8.0

VectorScript Declaration:

FUNCTION IsMarkerByClass

( h:HANDLE ) :BOOLEAN ;

Python:

def vs.IsMarkerByClass(h):
return BOOLEAN

Description:

Function IsMarkerByClass returns whether a class marker style is used for the referenced object.

説明

ハンドルで指定した図形のマーカの種類が、クラス属性を使用していた場合はTRUEを返します。

Parameters:

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

返り値

クラス属性を使用していた場合はTRUE

IsMaterialSimple

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION IsMaterialSimple

( materialHandle:HANDLE ) :BOOLEAN ;

Python:

def vs.IsMaterialSimple(materialHandle):
return BOOLEAN

説明

指定したマテリアルがシンプルタイプなのか、複合タイプなのかを判別します。シンプルタイプの場合はTRUEを返します。

IsMtrlFillStyleByCls

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION IsMtrlFillStyleByCls

( materialHandle:HANDLE ) :BOOLEAN ;

Python:

def vs.IsMtrlFillStyleByCls(materialHandle):
return BOOLEAN

説明

指定したマテリアルの面属性がクラス属性なのかどうかを判別します。複合マテリアルの場合は、メインのサブマテリアルの面属性に対して返します。クラス属性の場合は、TRUEを返します。

IsObjectFlipped

Object Attributes
VectorWorks8.0

VectorScript Declaration:

FUNCTION IsObjectFlipped

( h:HANDLE ) :BOOLEAN ;

Python:

def vs.IsObjectFlipped(h):
return BOOLEAN

Description:

Function IsObjectFlipped returns the flip orientation of the specified 3D object. The function returns TRUE if the object is currently flipped.

This function works for sweeps, extrudes, multiple extrudes, symbols, solids, layer references, and plug-in objects.

説明

ハンドルで指定した3次元図形（回転体、柱状体、多段柱状体、シンボル、ソリッド、プラグインオブジェクト）が反転されている場合はTRUEを返します。

Parameters:

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

返り値

反転の場合はTRUE

Example:
FUNCTION ObjFlippedInWall(objH, wallH :HANDLE) :BOOLEAN;
BEGIN
	ObjFlippedInWall := ((Trunc(GetSymRot(objH)) <> Trunc(HAngle(wallH))) = IsObjectFlipped(objH)); 
END;
See Also:

IsFlipped

IsPenColorByClass

Object Attributes
VectorWorks8.0

VectorScript Declaration:

FUNCTION IsPenColorByClass

( h:HANDLE ) :BOOLEAN ;

Python:

def vs.IsPenColorByClass(h):
return BOOLEAN

Description:

Function IsPenColorByClass returns whether class pen colors are used for the referenced object.

説明

ハンドルで指定した図形の線の色が、クラス属性を使用していた場合はTRUEを返します。

Parameters:

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

返り値

クラス属性を使用していた場合はTRUE

IsPlanarObj

Object Attributes
Vectorworks 2016

VectorScript Declaration:

FUNCTION IsPlanarObj

( object :HANDLE;

VAR NewParam :LONGINT

) :BOOLEAN ;

Python:

def vs.IsPlanarObj(object):
return (BOOLEAN, NewParam)

説明

図形がプレイナー図形の場合には、trueを返します。

Parameters:

object Object to test 図形のハンドル

NewParam If object is planar, returns the planar refID of its plane 図形がプレイナー図形の場合、平面参照番号を返します

IsTextStyleByClass

Object Attributes
Vectorworks 2015

VectorScript Declaration:

FUNCTION   IsTextStyleByClass

( objectId:HANDLE ) :BOOLEAN ;

Python:

def  vs.IsTextStyleByClass(objectId):
return BOOLEAN

Description:

Procedure IsTextStyleByClass returns whether the class text style is used for the referenced object.

説明

指定した図形がクラスの文字スタイルを使用しているかどうかを返します。

Parameters:

objectId handle to object 図形のハンドル

See Also:

SetTextStyleRef   GetTextStyleRef   SetTextStyleRefN   GetTextStyleRefN   SetTextStyleByClass   SetTextStyleByClassN   IsTextStyleByClass   IsTextStyleByClassN

RemoveSubMtrlFromMtl

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION RemoveSubMtrlFromMtl

( hMaterial :HANDLE;

subMtrlName :STRING

) :Boolean ;

Python:

def vs.RemoveSubMtrlFromMtl(hMaterial, subMtrlName):
return Boolean

Description:

Removes a Simple material from a Compound material.

説明

指定した複合マテリアルからシンプルマテリアルを削除します。

Parameters:

hMaterial Handle of a Compound material 複合マテリアルのハンドル

subMtrlName Name of a Simple material to be deleted 削除するシンプルマテリアルの名前

Result:

Returns true if successful; false otherwise. Returns false if the simple material is not found.

返り値

成功すると、TRUEを返します。シンプルマテリアルが見つからない場合はFALSEを返します。

SetClass

Object Attributes
MiniCAD

VectorScript Declaration:

PROCEDURE SetClass

( h :HANDLE;

class :STRING

) ;

Python:

def vs.SetClass(h, class):
return None

Description:

Procedure SetClass assigns a class to the referenced object.

説明

ハンドルで指定した図形のクラスを変更します。

Parameters:

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

class Name of class to assign to object. クラスの名前

Example:
SetClass(ObjHd,'Dimension');

SetClassN

Object Attributes
Vectorworks 2018

VectorScript Declaration:

PROCEDURE SetClassN

( h :HANDLE;

class :STRING;

descIntoGroup :BOOLEAN

) ;

Python:

def vs.SetClassN(h, class, descIntoGroup):
return None

Description:

Procedure SetClassN assigns a class to the referenced object.
If the third parameter 'descIntoGroup' is set to true all objects within the group will receive the same class assignment as the group,
otherwise only the group itself will be affected.

説明

指定したオブジェクトにクラスを割り当てます。
'descIntoGroup'がTrueに設定されている場合、グループ内すべてのオブジェクトにグループと同じクラスを割り当てます。
それ以外の場合は、グループ図形にのみクラスを割り当てます。

Parameters:

h Handle to object. オブジェクトのハンドル

class Name of class to assign to object. クラスの名前

descIntoGroup Assign the same class to all objects inside the group. グループ内すべての図形にクラスを割り当てるかどうか

Example:
{ select an object on drawing }
SetClassN(FSActLayer, 'Class Name-1', FALSE);
See Also:

SetClass

SetDescriptionText

Object Attributes
Vectorworks 2015

VectorScript Declaration:

FUNCTION   SetDescriptionText

( hObject :HANDLE;

descriptionText :DYNARRAY[] of CHAR

) :BOOLEAN ;

Python:

def  vs.SetDescriptionText(hObject, descriptionText):
return BOOLEAN

Description:

Sets the user-supplied description for an object.
Adds the description data node if one does not already exist.

説明

図形にユーザ定義の説明文を設定します。
説明文が未設定の場合データノードを追加します。

Parameters:

hObject Handle of the object for which the description should be set. 図形のハンドル

descriptionText The description text to be set for the object 説明文

Result:

true if text was successfully set; false if error occurred.

返り値

説明文が正しく設定されたかどうかを返します。

See Also:

GetDescriptionText

SetDropShadowByCls

Object Attributes
Vectorworks 2017

VectorScript Declaration:

PROCEDURE SetDropShadowByCls

( h :HANDLE;

byClassValue :BOOLEAN

) ;

Python:

def vs.SetDropShadowByCls(h, byClassValue):
return None

SetDropShadowData

Object Attributes
Vectorworks 2017

VectorScript Declaration:

PROCEDURE SetDropShadowData

( h :HANDLE;

nUnits :INTEGER;

dOffset :REAL;

dBlurRadius :REAL;

dAngle :REAL;

nOpacity :INTEGER;

colorR :LONGINT;

colorG :LONGINT;

colorB :LONGINT

) ;

Python:

def vs.SetDropShadowData(h, nUnits, dOffset, dBlurRadius, dAngle, nOpacity, color):
return None

SetEntityMatrix

Object Attributes
Vectorworks 2011

VectorScript Declaration:

FUNCTION SetEntityMatrix

( objectHandle :HANDLE;

offsetX :REAL;

offsetY :REAL;

offsetZ :REAL;

rotationXAngle :REAL;

rotationYAngle :REAL;

rotationZAngle :REAL

) :BOOLEAN ;

Python:

def vs.SetEntityMatrix(objectHandle, offset, rotationXAngle, rotationYAngle, rotationZAngle):
return BOOLEAN

Description:

Sets the matrix of the plane for a planar object. If there is already a plane in the document with that matrix, the object will be set to be in that plane. Otherwise a new plane will be added to the document.

説明

プレイナー図形の平面マトリックスを設定します。すでに同じマトリックスを持つ平面が書類中にあれば、オブジェクトはその平面に設定されます。そうでなければ、書類に新しい平面が設定されます。

Parameters:

objectHandle The object whose plane is being set. 平面を設定するオブジェクト

offset The offset of the plane in current document units. 現在の書類の単位での平面のオフセット

rotationXAngle The rotation of the plane about the X-axis in degrees. X軸周りの平面の回転角度

rotationYAngle The rotation of the plane about the Y-axis in degrees. Y軸周りの平面の回転角度

rotationZAngle The rotation of the plane about the Z-axis in degrees. Z軸周りの平面の回転角度

Result:

Returns true if the object passed is a planar object.

返り値

渡されたオブジェクトがプレイナー図形の場合にはtrueを返します。

SetEntityMatrixN

Object Attributes
Vectorworks 2016

VectorScript Declaration:

FUNCTION   SetEntityMatrixN

( objectHandle :HANDLE;

uX :REAL;

uY :REAL;

uZ :REAL;

vX :REAL;

vY :REAL;

vZ :REAL;

wX :REAL;

wY :REAL;

wZ :REAL;

offsetX :REAL;

offsetY :REAL;

offsetZ :REAL

) :BOOLEAN ;

Python:

def  vs.SetEntityMatrixN(objectHandle, u, v, w, offset):
return BOOLEAN

Description:

Sets the matrix of the plane for a planar object. If there is already a plane in the document with that matrix, the object will be set to be in that plane. Otherwise a new plane will be added to the document.

説明

プレイナー図形の平面マトリックスを設定します。すでに同じマトリックスを持つ平面が書類中にあれば、オブジェクトはその平面に設定されます。そうでなければ、書類に新しい平面が設定されます。

Parameters:

objectHandle The object whose plane is being set. 平面を設定するオブジェクト

u The X, Y and Z values of the plane's u-vector in current document units. 現在の書類の単位での平面のUベクトル

v The X, Y and Z values of the plane's v-vector in current document units. 現在の書類の単位での平面のVベクトル

w The X, Y and Z values of the plane's w-vector in current document units. 現在の書類の単位での平面のWベクトル

offset The X, Y and Z offsets of the plane in current document units. 現在の書類の単位での平面のオフセット

Result:

Returns True if data was set successfully, False otherwise.

返り値

設定が成功した場合TRUEを返します。

See Also:

SetEntityMatrix

SetFillBack

Object Attributes
MiniCAD

VectorScript Declaration:

PROCEDURE   SetFillBack

( h :HANDLE;

colorR :LONGINT;

colorG :LONGINT;

colorB :LONGINT

) ;

Python:

def  vs.SetFillBack(h, color):
return None

Description:

Procedure SetFillBack sets the fill background color setting of the specified object. RGB values are in the range of 0~65535.

説明

ハンドルで指定した図形の面の地色を、指定した色に変更します。値の範囲は0から65535までです。

Parameters:

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

color RGB color value. 赤、緑、青の成分

See Also:

RGBToColorIndex   ColorIndexToRGB

SetFillColorByClass

Object Attributes
VectorWorks8.0

VectorScript Declaration:

PROCEDURE SetFillColorByClass

( h:HANDLE ) ;

Python:

def vs.SetFillColorByClass(h):
return None

Description:

Procedure SetFillColorByClass sets the referenced object to use the class attribute fill colors.

説明

ハンドルで指定した図形の面の色に、現在のクラス属性を使います。

Parameters:

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

SetFillFore

Object Attributes
MiniCAD

VectorScript Declaration:

PROCEDURE SetFillFore

( h :HANDLE;

colorR :LONGINT;

colorG :LONGINT;

colorB :LONGINT

) ;

Python:

def vs.SetFillFore(h, color):
return None

Description:

Procedure SetFillFore sets the fill foreground color setting of the referenced object. RGB values are in the range of 0~65535.

説明

ハンドルで指定した図形の面の色を、指定した色に変更します。値の範囲は0から65535までです。

Parameters:

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

color RGB color value. 赤、緑、青の成分

Example:
SetFillFore(h, 65535, 0, 0);
See Also:

RGBToColorIndex ColorIndexToRGB

SetFillIAxisEndPoint

Object Attributes
VectorWorks10.0

VectorScript Declaration:

PROCEDURE SetFillIAxisEndPoint

( objectHandle :HANDLE;

xIAxisEndPoint :REAL;

yIAxisEndPoint :REAL

) ;

Python:

def vs.SetFillIAxisEndPoint(objectHandle, xIAxisEndPoint, yIAxisEndPoint):
return None

Description:

Sets the I-axis end point of the fill.

Note: only works with 2D objects that have a gradient or image fill.

説明

I軸の終点座標を設定します。

注：グラデーションやイメージ属性をもつ2次元図形でのみ動作します。

Parameters:

objectHandle Handle to the object with fill. 図形のハンドル

xIAxisEndPoint X coordinate of I-axis point. I軸終点のX座標

yIAxisEndPoint Y coordinate of I-axis point. I軸終点のY座標

Example:
SetFillIAxisEndPoint(objectHandle, 20.0, 10.0);

SetFillJAxisEndPoint

Object Attributes
VectorWorks10.0

VectorScript Declaration:

PROCEDURE SetFillJAxisEndPoint

( objectHandle :HANDLE;

xJAxisEndPoint :REAL;

yJAxisEndPoint :REAL

) ;

Python:

def vs.SetFillJAxisEndPoint(objectHandle, xJAxisEndPoint, yJAxisEndPoint):
return None

Description:

Sets the J-axis end point of the fill.

Note: only works with 2D objects that have a gradient or image fill.

説明

J軸の終点座標を設定します。

注：グラデーションやイメージ属性をもつ2次元図形でのみ動作します。

Parameters:

objectHandle Handle to object with fill. 図形のハンドル

xJAxisEndPoint X coordinate of J-axis point. J軸終点のX座標

yJAxisEndPoint Y coordinate of J-axis point. J軸終点のY座標

Example:
SetFillJAxisEndPoint(objectHandle, 15.0, 25.0);

SetFillOriginPoint

Object Attributes
VectorWorks10.0

VectorScript Declaration:

PROCEDURE SetFillOriginPoint

( objectHandle :HANDLE;

xOriginPoint :REAL;

yOriginPoint :REAL

) ;

Python:

def vs.SetFillOriginPoint(objectHandle, xOriginPoint, yOriginPoint):
return None

Description:

Sets the origin point of the fill.

Note: only works with 2D objects that have a gradient or image fill.

説明

原点座標を設定します。

注：グラデーションやイメージ属性をもつ2次元図形でのみ動作します。

Parameters:

objectHandle Handle to the object with fill. 図形のハンドル

xOriginPoint X coordinate of origin point. 原点のX座標

yOriginPoint Y coordinate of origin point. 原点のY座標

Example:
SetFillOriginPoint(objectHandle, 10.0, 20.0);

SetFPat

Object Attributes
MiniCAD

VectorScript Declaration:

PROCEDURE SetFPat

( h :HANDLE;

fillPattern :LONGINT

) ;

Python:

def vs.SetFPat(h, fillPattern):
return None

Description:

Procedure SetFPat sets the fill pattern of the referenced object.

To apply a bitmap fill pattern, use positive value corresponding to the index of the bitmap pattern. To apply a vector fill pattern, use the negative of the vector fill index (index * -1).

Fill patterns and their associated constants can be found in the VectorScript Appendix.

説明

ハンドルで指定した図形の面の模様を、指定した模様番号に変更します。

ビットマップは0から71までの正の値で示されています。ハッチングは負の値で示されています。

Parameters:

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

fillPattern Fill index value. 模様番号

Example:
{ Apply a bitmap fill pattern. }
SetFPat(objectOne, 47);

{ Apply a vector fill. }
SetFPat(objectTwo, -Name2Index('My Hatch'));

SetFPatByClass

Object Attributes
VectorWorks8.0

VectorScript Declaration:

PROCEDURE SetFPatByClass

( h:HANDLE ) ;

Python:

def vs.SetFPatByClass(h):
return None

Description:

Procedure SetFPatByClass sets the referenced object to use the class attribute fill pattern.

説明

ハンドルで指定した図形の面の模様に、現在のクラス属性を使います。

Parameters:

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

SetLS

Object Attributes
MiniCAD - obsolete as of Vectorworks 2013

VectorScript Declaration:

PROCEDURE SetLS

( h :HANDLE;

ls :INTEGER

) ;

Python:

def vs.SetLS(h, ls):
return None

Special Notes:

SetLS is obsolete as of Vectorworks 2013

Description:

Deprecated - will generate error. Use SetLSN instead.

説明

ハンドルで指定した図形の線の模様／種類を変更します。

lsに0から71までの値を設定すると、ビットマップの線の模様が設定されます。
-1から-8までの値を設定すると、線の種類が設定されます。

Parameters:

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

ls Linestyle to apply to object. 模様番号

Example:
PROCEDURE Example;
VAR
	cnt :INTEGER;
BEGIN
	PushAttrs;
	TextSize(1);
	TextJust(3);
	TextVerticalAlign(3);
	FOR cnt := -10 TO 71 DO BEGIN
		TextOrigin(-2, cnt);
		CreateText(Concat(cnt));
		MoveTo(0, cnt);
		LineTo(24", cnt);
		SetLS(LNewObj, cnt);
	END;
	PopAttrs;
END;
RUN(Example);
See Also:

SetLSN

SetLSByClass

Object Attributes
VectorWorks8.0

VectorScript Declaration:

PROCEDURE SetLSByClass

( h:HANDLE ) ;

Python:

def vs.SetLSByClass(h):
return None

Description:

Procedure SetLSByClass sets the referenced object to use the class attribute line style.

説明

ハンドルで指定した図形の線の種類に、現在のクラス属性を使います。

Parameters:

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

SetLSN

Object Attributes
Vectorworks 2013

VectorScript Declaration:

PROCEDURE   SetLSN

( h :HANDLE;

ls :LONGINT

) ;

Python:

def  vs.SetLSN(h, ls):
return None

Description:

Procedure SetLSN sets the linestyle of the referenced object.

If the value is in the range 0 to 71, the specified fill pattern is applied as the linestyle; a negative value will apply the line type whose index is the negative of the value.

説明

ハンドルで指定した図形の線の模様／種類を、0から71の値または負の値で設定します。

Parameters:

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

ls Linestyle to apply to object. 模様／種類番号

See Also:

GetLSN

SetLW

Object Attributes
MiniCAD

VectorScript Declaration:

PROCEDURE SetLW

( h :HANDLE;

lw :INTEGER

) ;

Python:

def vs.SetLW(h, lw):
return None

Description:

Procedure SetLW sets the line weight of the referenced object.

説明

ハンドルで指定した図形の線の太さを変更します。

Parameters:

h Handle to object 図形のハンドル

lw Line weight to be applied to object (in mils). 線の太さ

Example:
SetLW(ObjHd,12);

SetLWByClass

Object Attributes
VectorWorks8.0

VectorScript Declaration:

PROCEDURE SetLWByClass

( h:HANDLE ) ;

Python:

def vs.SetLWByClass(h):
return None

Description:

Procedure SetLWByClass sets the referenced object to use the class attribute line weight.

説明

ハンドルで指定した図形の線の太さに、現在のクラス属性を使います。

Parameters:

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

SetMarker

Object Attributes
VectorWorks10.0 - obsolete as of VectorWorks 2008

VectorScript Declaration:

PROCEDURE SetMarker

( h :HANDLE;

start :BOOLEAN;

end :BOOLEAN;

style :INTEGER;

size :REAL

) ;

Python:

def vs.SetMarker(h, start, end, style, size):
return None

Special Notes:

SetMarker is obsolete as of VectorWorks 2008

Description:

Specifies marker information for the referenced object - OBSOLETE procedure: Use SetObjBeginningMarker and/or SetObjEndMarker instead.

説明

ハンドルで指定した図形にマーカを設定します。

VW2008で使用できなくなった関数／手続きです。
SetObjBeginningMarker、SetObjEndMarkerをご利用ください。

Parameters:

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

start True if a marker is visible at start of object. 始点にマーカをつける場合はTRUE

end True if a marker is visible at end of object. 終点にマーカをつける場合はTRUE

style Marker style: 0 - Filled Arrow Marker 1 - Empty Arrow Marker 2 - Open Arrow Marker 3 - Filled Ball Marker 4 - Empty Ball Marker 5 - Slash Marker 6 - Cross Marker スタイル

size Size of marker 長さ（インチ）

Example:
PROCEDURE Example;
BEGIN
   MoveTo(0, 0);
   LineTo(100, 0);
   SetMarker(LNewObj, TRUE, FALSE, 2, 10000);
END;
RUN(Example);
See Also:

GetMarker SetObjBeginningMarker SetObjEndMarker

SetMarkerByClass

Object Attributes
VectorWorks8.0

VectorScript Declaration:

PROCEDURE   SetMarkerByClass

( h:HANDLE ) ;

Python:

def  vs.SetMarkerByClass(h):
return None

Description:

Procedure SetMarkerByClass sets the referenced object to use the class attribute marker style.

説明

ハンドルで指定した図形のマーカの種類に、現在のクラス属性を使います。

Parameters:

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

See Also:

SetObjArrow

SetMaterialFillStyle

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION SetMaterialFillStyle

( materialHandle :HANDLE;

fillStyle :LONGINT

) :BOOLEAN ;

Python:

def vs.SetMaterialFillStyle(materialHandle, fillStyle):
return BOOLEAN

説明

指定したマテリアルの面の属性を設定します。面の属性はシンプルタイプのマテリアルにのみ設定できます。クラス属性を解除することもできます。成功するとTRUEを返します。面の属性が無効な場合は、「なし」に設定します。

Parameters:

fillStyle InternalIndex of fillStyle 面の属性番号

SetMaterialTexture

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION SetMaterialTexture

( VAR materialHandle :HANDLE;

textureIndex :LONGINT

) :BOOLEAN ;

Python:

def vs.SetMaterialTexture(materialHandle, textureIndex):
return (BOOLEAN, materialHandle)

説明

指定したマテリアルのテクスチャを設定します。テクスチャはシンプルタイプのマテリアルにのみ設定できます。成功するとTRUEを返します。textureIndexが無効な場合は、「なし」に設定します。

SetMtlFillBackColor

Object Attributes
Vectorworks 2021

VectorScript Declaration:

PROCEDURE SetMtlFillBackColor

( material :HANDLE;

colorR :LONGINT;

colorG :LONGINT;

colorB :LONGINT

) ;

Python:

def vs.SetMtlFillBackColor(material, color):
return None

Description:

Sets the fill background color of the specified material. The color must be specified using the RGB components of the desired color. RGB values are in the range of 0~65535.

説明

指定したマテリアルの背景色をRGB値で設定します。色は赤、緑、青の成分で指定します。値の範囲は0から65535までです。

Parameters:

material Handle to material. マテリアルのハンドル

color RGB color value. 赤、緑、青の成分

Example:
ColorIndexToRGB(214,cRed,cGrn,cBlu);
SetMtlFillBackColor(mtlHandle,cRed,cGrn,cBlu);

SetMtlFillForeColor

Object Attributes
Vectorworks 2021

VectorScript Declaration:

PROCEDURE SetMtlFillForeColor

( material :HANDLE;

colorR :LONGINT;

colorG :LONGINT;

colorB :LONGINT

) ;

Python:

def vs.SetMtlFillForeColor(material, color):
return None

Description:

Sets the fill foreground color of the specified material. The color must be specified using the RGB components of the desired color. RGB values are in the range of 0~65535.

説明

指定したマテリアルの前景色をRGB値で設定します。色は赤、緑、青の成分で指定します。値の範囲は0から65535までです。

Parameters:

material Handle to material. マテリアルのハンドル

color RGB color value. 赤、緑、青の成分

Example:
ColorIndexToRGB(214,cRed,cGrn,cBlu);
SetMtlFillForeColor(mtlHandle,cRed,cGrn,cBlu);

SetMtlFillStyleByCls

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION SetMtlFillStyleByCls

( materialHandle :HANDLE;

isByClass :BOOLEAN

) :BOOLEAN ;

Python:

def vs.SetMtlFillStyleByCls(materialHandle, isByClass):
return BOOLEAN

説明

指定したマテリアルの面の属性をクラス属性に設定します。面の属性はシンプルタイプのマテリアルにのみ設定できます。面の属性を「なし」に設定することもできます。成功するとTRUEを返します。

SetMtlPenBackColor

Object Attributes
Vectorworks 2021 - obsolete as of Vectorworks 2022

VectorScript Declaration:

PROCEDURE SetMtlPenBackColor

( material :HANDLE;

colorR :LONGINT;

colorG :LONGINT;

colorB :LONGINT

) ;

Python:

def vs.SetMtlPenBackColor(material, color):
return None

Special Notes:

SetMtlPenBackColor is obsolete as of Vectorworks 2022

Description:

Deprecated - will generate error.

説明

指定したマテリアルの線の背景色をRGB値で設定します。色は赤、緑、青の成分で指定します。値の範囲は0から65535までです。

Parameters:

material Handle to material. マテリアルのハンドル

color RGB color value. 赤、緑、青の成分

Example:
ColorIndexToRGB(214,cRed,cGrn,cBlu);
SetMtlPenBackColor(mtlHandle,cRed,cGrn,cBlu);

SetMtlPenForeColor

Object Attributes
Vectorworks 2021 - obsolete as of Vectorworks 2022

VectorScript Declaration:

PROCEDURE SetMtlPenForeColor

( material :HANDLE;

colorR :LONGINT;

colorG :LONGINT;

colorB :LONGINT

) ;

Python:

def vs.SetMtlPenForeColor(material, color):
return None

Special Notes:

SetMtlPenForeColor is obsolete as of Vectorworks 2022

Description:

Deprecated - will generate error.

説明

指定したマテリアルの線の前景色をRGB値で設定します。色は赤、緑、青の成分で指定します。値の範囲は0から65535までです。

Parameters:

material Handle to material. マテリアルのハンドル

color RGB color value. 赤、緑、青の成分

Example:
ColorIndexToRGB(214,cRed,cGrn,cBlu);
SetMtlPenForeColor(mtlHandle,cRed,cGrn,cBlu);

SetObjArrow

Object Attributes
VectorWorks10.0 - obsolete as of VectorWorks 2008

VectorScript Declaration:

PROCEDURE SetObjArrow

( obj :HANDLE;

style :INTEGER;

size :REAL;

angle :INTEGER;

start :BOOLEAN;

end :BOOLEAN

) ;

Python:

def vs.SetObjArrow(obj, style, size, angle, start, end):
return None

Special Notes:

SetObjArrow is obsolete as of VectorWorks 2008

Description:

Procedure SetObjArrow sets the arrow style parameters for the indicated object.

Marker Styles

Marker Style Constant

Filled Arrow 0

Empty Arrow 1

Open Arrow 2

Filled Circle 3

Empty Circle 4

Slash 5

Cross 6

説明

ハンドルで指定した図形にマーカを設定します。

VW2008で使用できなくなった関数／手続きです。
SetObjBeginningMarker、SetObjEndMarkerをご利用ください。

Parameters:

obj The indicated object. 図形のハンドル

style The arrow style. スタイル

size The arrow size in inches measured in page space. 長さ（インチ）

angle The arrow angle (in degrees). 角度（度）

start Whether the start point of the object has an arrow. 始点にマーカをつける場合はTRUE

end Whether the endpoint of the object has an arrow. 終点にマーカをつける場合はTRUE

Example:
PROCEDURE SetObjArrowValues;
BEGIN
	SetObjArrow(FSActLayer, 1, .25, 15, TRUE, TRUE);
END;
RUN(SetObjArrowValues);

SetObjBeginningMarker

Object Attributes
VectorWorks 2008

VectorScript Declaration:

FUNCTION SetObjBeginningMarker

( object :HANDLE;

style :LONGINT;

angle :INTEGER;

size :REAL;

width :REAL;

thicknessBasis :INTEGER;

thickness :REAL;

visibility :BOOLEAN

) :BOOLEAN ;

Python:

def vs.SetObjBeginningMarker(object, style, angle, size, width, thicknessBasis, thickness, visibility):
return BOOLEAN

Description:

Sets all properties of an object's beginning marker. Return TRUE if operation was successful.

説明

ハンドルで指定した図形の始点マーカのすべての設定値を設定します。正常終了するとTRUEが返されます。

Parameters:

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

style The marker style. (see comments for details) タイプ

angle The marker angle in degrees. (0 to 90) 角度（度数、0から90）

size The marker size in page inches. 長さ（インチ）

width The marker width in page inches. 幅（インチ）

thicknessBasis The marker thickness basis. ( see comments for details) 太さ

thickness The marker thickness. カスタム設定の太さ

visibility The marker visibility. 表示／非表示

Example:
PROCEDURE Example;
VAR
	ok : BOOLEAN;
	
BEGIN
	MoveTo (0,0);
LineTo (100, 0);
	ok := SetObjBeginningMarker(LNewObj, 1280, 25, 0.25, 0.125, 34, 2, TRUE);	
END;

RUN(Example);
See Also:

SetObjEndMarker

SetObjEndMarker

Object Attributes
VectorWorks 2008

VectorScript Declaration:

FUNCTION SetObjEndMarker

( object :HANDLE;

style :LONGINT;

angle :INTEGER;

size :REAL;

width :REAL;

thicknessBasis :INTEGER;

thickness :REAL;

visibility :BOOLEAN

) :BOOLEAN ;

Python:

def vs.SetObjEndMarker(object, style, angle, size, width, thicknessBasis, thickness, visibility):
return BOOLEAN

Description:

Sets all properties of an object's end marker. Return TRUE if operation was successful.

説明

ハンドルで指定した図形の終点マーカのすべての設定値を設定します。正常終了するとTRUEが返されます。

Parameters:

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

style The marker style. (see comments for details) タイプ

angle The marker angle in degrees. (0 to 90) 角度（度数、0から90）

size The marker size in page inches. 長さ（インチ）

width The marker width in page inches. 幅（インチ）

thicknessBasis The marker thickness basis. ( see comments for details) 太さ

thickness The marker thickness. カスタム設定の太さ

visibility The marker visibility. 表示／非表示

Example:
PROCEDURE Example;
VAR
	ok : BOOLEAN;
	
BEGIN
	MoveTo (0,0);
LineTo (100, 0);
	ok := SetObjEndMarker(LNewObj, 1280, 25, 0.25, 0.125, 34, 2, TRUE);	
END;

RUN(Example);
See Also:

SetObjBeginningMarker

SetObjMaterialHandle

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION SetObjMaterialHandle

( VAR objectHandle :HANDLE;

materialHandle :HANDLE

) :BOOLEAN ;

Python:

def vs.SetObjMaterialHandle(objectHandle, materialHandle):
return (BOOLEAN, objectHandle)

説明

指定したオブジェクトが使用しているマテリアルに指定したハンドルを設定します。成功するとTRUEを返します。

SetOpacity

Object Attributes
VectorWorks 2008

VectorScript Declaration:

PROCEDURE SetOpacity

( h :HANDLE;

opacity :INTEGER

) ;

Python:

def vs.SetOpacity(h, opacity):
return None

Description:

Sets the opacity of the object to the opacity passed in.

説明

ハンドルで指定した図形の不透明度を設定します。

SetOpacityByClass

Object Attributes
VectorWorks 2008

VectorScript Declaration:

PROCEDURE SetOpacityByClass

( h:HANDLE ) ;

Python:

def vs.SetOpacityByClass(h):
return None

Description:

Sets the specified class to use the class opacity.

説明

ハンドルで指定した図形の不透明度に、現在のクラス属性を使います。

SetOpacityByClassN

Object Attributes
Vectorworks 2017

VectorScript Declaration:

PROCEDURE SetOpacityByClassN

( h :HANDLE;

inIsPenOpacityByClass :BOOLEAN;

inIsFillOpacityByClass :BOOLEAN

) ;

Python:

def vs.SetOpacityByClassN(h, inIsPenOpacityByClass, inIsFillOpacityByClass):
return None

SetOpacityN

Object Attributes
Vectorworks 2017

VectorScript Declaration:

FUNCTION SetOpacityN

( h :HANDLE;

inPenOpacity :INTEGER;

inFillOpacity :INTEGER

) :BOOLEAN ;

Python:

def vs.SetOpacityN(h, inPenOpacity, inFillOpacity):
return BOOLEAN

Parameters:

h HANDLE of the object 図形のハンドル

inPenOpacity Pen opacity value to set. 線の不透明度

inFillOpacity Fill opacity value to set. 面の不透明度

SetPenBack

Object Attributes
MiniCAD

VectorScript Declaration:

PROCEDURE   SetPenBack

( h :HANDLE;

colorR :LONGINT;

colorG :LONGINT;

colorB :LONGINT

) ;

Python:

def  vs.SetPenBack(h, color):
return None

Description:

Procedure SetPenBack sets the pen background color of the referenced object. RGB values are in the range of 0~65535.

説明

ハンドルで指定した図形の線の地色を、指定した色に変更します。値の範囲は0から65535までです。

Parameters:

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

color RGB color value. 赤、緑、青の成分

See Also:

RGBToColorIndex   ColorIndexToRGB

SetPenColorByClass

Object Attributes
VectorWorks8.0

VectorScript Declaration:

PROCEDURE SetPenColorByClass

( h:HANDLE ) ;

Python:

def vs.SetPenColorByClass(h):
return None

Description:

Procedure SetPenColorByClass sets the referenced object to use the class attribute pen colors.

説明

ハンドルで指定した図形の線の色に、現在のクラス属性を使います。

Parameters:

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

SetPenFore

Object Attributes
MiniCAD

VectorScript Declaration:

PROCEDURE SetPenFore

( h :HANDLE;

colorR :LONGINT;

colorG :LONGINT;

colorB :LONGINT

) ;

Python:

def vs.SetPenFore(h, color):
return None

Description:

Procedure SetPenFore sets the pen foreground color of the referenced object. RGB values are in the range of 0~65535.

説明

ハンドルで指定した図形の線の色を、指定した色に変更します。値の範囲は0から65535までです。

Parameters:

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

color RGB color value. 赤、緑、青の成分

Example:
SetPenFore(HandleToObj,65535,0,39321); 
See Also:

RGBToColorIndex ColorIndexToRGB

SetTextStyleByClass

Object Attributes
Vectorworks 2015

VectorScript Declaration:

PROCEDURE   SetTextStyleByClass

( objectId:HANDLE ) ;

Python:

def  vs.SetTextStyleByClass(objectId):
return None

Description:

SetTextStyleByClass sets the referenced object to use the class text style. To undo this, use SetTextStyleRef on the object.

説明

指定した図形がクラスの文字スタイルを使用するように設定します。設定を取り消すには、 SetTextStyleRef を使用します。

Parameters:

objectId handle to object 図形のハンドル

See Also:

SetTextStyleRef   GetTextStyleRef   SetTextStyleRefN   GetTextStyleRefN   SetTextStyleByClass   SetTextStyleByClassN   IsTextStyleByClass   IsTextStyleByClassN

SetViewMatrix

Object Attributes
VectorWorks10.5

VectorScript Declaration:

FUNCTION SetViewMatrix

( objectHandle :HANDLE;

offsetX :REAL;

offsetY :REAL;

offsetZ :REAL;

rotationXAng :REAL;

rotationYAng :REAL;

rotationZAng :REAL

) :BOOLEAN ;

Python:

def vs.SetViewMatrix(objectHandle, offset, rotationXAng, rotationYAng, rotationZAng):
return BOOLEAN

Description:

Sets view matrix for layer or viewport object.

説明

レイヤやビューポートの見る方向を設定します。

ShowOnlySelected

Object Attributes
Vectorworks 2025

VectorScript Declaration:

PROCEDURE ShowOnlySelected

;

Python:

def vs.ShowOnlySelected():
return None

Description:

Sets the object visibility of all unselected objects to "invisible". Hidden objects can be made visible with Show or UnHideObjects commands.

説明

選択されていないすべてのオブジェクトを非表示に設定します。非表示のオブジェクトは、ShowまたはUnHideObjectsコマンドを使用して表示できます。

Example:
ShowOnlySelected();

UnHideObjects

Object Attributes
Vectorworks 2025

VectorScript Declaration:

PROCEDURE UnHideObjects

;

Python:

def vs.UnHideObjects():
return None

Description:

Changes the object visibility to "visible" for all objects hidden with Hide, HideSelectedObjects and ShowOnlySelected commands. The object will only become visible if it is also on a visible layer and class.

説明

Hide、HideSelectedObjects、およびShowOnlySelectedコマンドで非表示にされたすべてのオブジェクトを表示に変更します。オブジェクトは、表示されているレイヤおよびクラスに存在する場合のみ表示されます。

Example:
UnHideObjects();

UpdateSubMtrlInMtrl

Object Attributes
Vectorworks 2021

VectorScript Declaration:

FUNCTION UpdateSubMtrlInMtrl

( hMaterial :HANDLE;

subMtrlName :STRING;

fraction :REAL;

makePrimary :BOOLEAN

) :Boolean ;

Python:

def vs.UpdateSubMtrlInMtrl(hMaterial, subMtrlName, fraction, makePrimary):
return Boolean

Description:

Updates a Simple material which is a part of a Compound material. Sets new values for its fraction and whether it should be the primary material. Fraction can have value between 0.0 and 1.0. "Primary" material is a simple material which carries the graphical attributes to be used by the compound material.

説明

複合マテリアルに含まれているシンプルマテリアルを更新します。新しい割合の値と、更新するシンプルマテリアルをメインのマテリアルにするかどうかを設定します。割合は0.0から1.0の間で指定します。「Primary」（メイン）マテリアルとは、複合マテリアルにおいてグラフィック属性を扱うシンプルマテリアルのことです。

Parameters:

hMaterial Handle of a Compound material 複合マテリアルのハンドル

subMtrlName Name of a Simple material to be updated 更新するシンプルマテリアルの名前

fraction Fraction of the Simple material シンプルマテリアルの割合

makePrimary True if this Simple material should become the primary material of the Compound material このシンプルマテリアルを複合マテリアルのメインマテリアルにする場合にTRUEにします。

Result:

Returns true if successful; false otherwise. Returns false if the simple material was not found.

返り値

成功すると、TRUEを返します。シンプルマテリアルが見つからない場合はFALSEを返します。

UpdateThumbnailPreview

Object Attributes
VectorWorks11.0

VectorScript Declaration:

FUNCTION UpdateThumbnailPreview

( resourceHandle:HANDLE ) :BOOLEAN ;

Python:

def vs.UpdateThumbnailPreview(resourceHandle):
return BOOLEAN

Description:

For a given Vectorworks resource (i.e. Hatch, Texture, Symbol/PIO, etc...), this function will create or update it's thumbnail preview.

説明

VectorWorksのリソース（ハッチング、テクスチャ、シンボル、プラグインオブジェクトなど）のサムネイルプレビューを作成、または更新します。

Parameters:

resourceHandle Handle to the resource. リソースのハンドル

Result:

This function returns true if the operation was successful, false otherwise.

返り値

TRUE：サムネイルプレビューの作成、または更新に成功しました。
FALSE：サムネイルプレビューの作成、または更新に失敗しました。

hMaterial	Handle of a Compound material	複合マテリアルのハンドル
subMtrlName	Name of a Simple material to be added	追加するシンプルマテリアルの名前
fraction	Fraction of the Simple material	シンプルマテリアルの割合
makePrimary	True if this Simple material should become the primary material of the Compound material	このシンプルマテリアルを複合マテリアルのメインマテリアルにする場合にTRUEにします。

hObject	Handle of object for which to retrieve the text.	図形のハンドル
descriptionText	Object's description text, if any exists.	図形の説明文

objectHandle	The object for which the matrix of its plane is being obtained.	マトリックスを取得したいオブジェクト
offset	The offset of the plane in current document units.	現在の書類の単位での平面のオフセット
rotationXAngle	The rotation of the plane about the X-axis in degrees.	X軸周りの平面の回転角度
rotationYAngle	The rotation of the plane about the Y-axis in degrees.	Y軸周りの平面の回転角度
rotationZAngle	The rotation of the plane about the Z-axis in degrees.	Z軸周りの平面の回転角度

h	Handle to object.	図形のハンドル
red	Returns RGB color component value.	赤の成分
green	Returns RGB color component value.	緑の成分
blue	Returns RGB color component value.	青の成分

objectHandle	Handle to the object with fill.	図形のハンドル
xIAxisEndPoint	X coordinate of I-axis point.	I軸終点のX座標
yIAxisEndPoint	Y coordinate of I-axis point.	I軸終点のY座標

h	Handle to the object containing the fill space.	オブジェクトのハンドル
index	Index of the fill space to be returned.	フィル空間のインデックス

h	Handle to the object.	図形のハンドル
start	True if a marker is visible at start of object.	始点にマーカがある場合はTRUE
end	True if a marker is visible at end of object.	終点にマーカがある場合はTRUE
style	Marker style: 0 - Filled Arrow Marker 1 - Empty Arrow Marker 2 - Open Arrow Marker 3 - Filled Ball Marker 4 - Empty Ball Marker 5 - Slash Marker 6 - Cross Marker	スタイル
size	Size of marker.	長さ（インチ）

h	Handle to object.	オブジェクトのハンドル
material	Name of material.	マテリアルの名前

material	Handle to material.	マテリアルのハンドル
red	Returns RGB color component (red).	赤の成分
green	Returns RGB color component (green).	緑の成分
blue	Returns RGB color component (blue).	青の成分

obj	The indicated object.	図形のハンドル
style	Returns arrow style.	スタイル
size	Returns arrow size in inches measured in page space.	長さ（インチ）
angle	Returns arrow angle (in degrees).	角度（度）
start	Returns whether the start point of the object has an arrow.	始点にマーカがある場合はTRUE
end	Returns whether the endpoint of the object has an arrow.	終点にマーカがある場合はTRUE

object	Handle to object.	図形のハンドル
style	The marker style. (see comments for details)	タイプ
angle	The marker angle in degrees. (0 to 90)	角度（度数、0から90）
size	The marker size in inches.	高さ（インチ）
width	The marker width in inches.	幅（インチ）
thicknessBasis	The marker thickness basis. ( see comments for details)	太さ
thickness	The marker thickness.	カスタム設定の太さ
visibility	The marker visibility.	表示／非表示

h	The object which opacity will be get.	図形のハンドル
opacity	Output parameter. Return the object's opacity as percentage value in range [0-100].	図形の不透明度を、0から100までの値で返します。

h	Object handle to get the opacity values.	図形のハンドル
outPenOpacity	Output parameter. Return the object's pen opacity as percentage value in range [0-100].	線の不透明度 (0-100%)
outFillOpacity	Output parameter. Return the object's fill opacity as percentage value in range [0-100].	面の不透明度 (0-100%)

object	Object to test	図形のハンドル
NewParam	If object is planar, returns the planar refID of its plane	図形がプレイナー図形の場合、平面参照番号を返します

h	Handle to object.	図形のハンドル
class	Name of class to assign to object.	クラスの名前

hObject	Handle of the object for which the description should be set.	図形のハンドル
descriptionText	The description text to be set for the object	説明文

objectHandle	The object whose plane is being set.	平面を設定するオブジェクト
offset	The offset of the plane in current document units.	現在の書類の単位での平面のオフセット
rotationXAngle	The rotation of the plane about the X-axis in degrees.	X軸周りの平面の回転角度
rotationYAngle	The rotation of the plane about the Y-axis in degrees.	Y軸周りの平面の回転角度
rotationZAngle	The rotation of the plane about the Z-axis in degrees.	Z軸周りの平面の回転角度

h	Handle to object.	図形のハンドル
color	RGB color value.	赤、緑、青の成分

objectHandle	Handle to object with fill.	図形のハンドル
xJAxisEndPoint	X coordinate of J-axis point.	J軸終点のX座標
yJAxisEndPoint	Y coordinate of J-axis point.	J軸終点のY座標

h	Handle to object.	図形のハンドル
fillPattern	Fill index value.	模様番号

h	Handle to object.	図形のハンドル
ls	Linestyle to apply to object.	模様番号

h	Handle to object	図形のハンドル
lw	Line weight to be applied to object (in mils).	線の太さ

h	Handle to the object	図形のハンドル
start	True if a marker is visible at start of object.	始点にマーカをつける場合はTRUE
end	True if a marker is visible at end of object.	終点にマーカをつける場合はTRUE
style	Marker style: 0 - Filled Arrow Marker 1 - Empty Arrow Marker 2 - Open Arrow Marker 3 - Filled Ball Marker 4 - Empty Ball Marker 5 - Slash Marker 6 - Cross Marker	スタイル
size	Size of marker	長さ（インチ）

Marker Style	Constant
Filled Arrow	0
Empty Arrow	1
Open Arrow	2
Filled Circle	3
Empty Circle	4
Slash	5
Cross	6

h	HANDLE of the object	図形のハンドル
inPenOpacity	Pen opacity value to set.	線の不透明度
inFillOpacity	Fill opacity value to set.	面の不透明度