VectorScript Declaration:

FUNCTION   AddTileGeometryObject

(   tileHandle :HANDLE;     objectHandle :HANDLE ) :BOOLEAN ;

Python:

def  vs.AddTileGeometryObject(tileHandle, objectHandle):

   return BOOLEAN

Description:

Adds the specified object to the specified tile resource.

説明

指定したタイルリソースに指定した図形を追加します。

Parameters:

tileHandle	The handle to the tile resource.	タイルのハンドル
objectHandle	The handle to the object to add.	追加する図形のハンドル

Result:

TRUE if a valid object was successfully added; FALSE otherwise.

返り値

オブジェクトが追加されたらTRUEが返ります

Example:

return := AddTileGeometryGroup(tileHandle, objectHandle);

See Also:

CreateTile   ShowEditTileDialog   ShowEditTileSettingsDialog   ShowNewTileDialog   GetTileGeometryGroup   BeginGroupN   AddTileGeometryObject   GetTileGroupParent   IsTileGroupContainedObject   GetTileBackgroundColor   SetTileBackgroundColor   GetTileRepetitionPoint   SetTileRepetitionPoint   GetTileOffsetPoint   SetTileOffsetPoint  

VectorScript Declaration:

FUNCTION   CreateImageFromPaint

(   paint :HANDLE;     imageName :STRING ) :HANDLE ;

Python:

def  vs.CreateImageFromPaint(paint, imageName):

   return HANDLE

Description:

Creates an image resource from a paint node.

説明

ペイントノードからイメージを作成します。

Parameters:

paint	Handle to the paint node to be used to create the image resource.	ペイントノードのハンドル
imageName	User-specified name to be used to identify the newly created image resource.	イメージの名前

Result:

Returns the handle to the newly create image resource if successful; nil otherwise.

返り値

新しく作成されたイメージのハンドルを返します。その他の場合はNILを返します。

Example:

imageHandle := CreateImageFromPaint(paintHandle, 'My Image');

VectorScript Declaration:

FUNCTION   CreateImgFromSymbol

(   symbolName :STRING;     symbolHeight :INTEGER;     symbolWidth :INTEGER;     symbolMargin :INTEGER;     renderMode :INTEGER;     view :INTEGER ) :HANDLE ;

Python:

def  vs.CreateImgFromSymbol(symbolName, symbolHeight, symbolWidth, symbolMargin, renderMode, view):

   return HANDLE

Parameters:

symbolName	The name of the symbol to display.	シンボルの表示名
symbolHeight	The height of the symbol to display.	シンボルの高さ
symbolWidth	The width of the symbol to display.	シンボルの幅
symbolMargin	The margin of the symbol to display.	シンボルの間隔
renderMode	The render mode in which to display the symbol.	シンボルのレンダリングモード
view	The standard view in which to display the symbol.	シンボルの基本のビュー

Result:

Returns the handle to the newly create image resource if successful; nil otherwise.

返り値

シンボルからシメージリソースを作成します。成功した場合、新しく作成されたイメージリソースのハンドルを返します。 失敗した場合は nil を返します。

VectorScript Declaration:

FUNCTION   CreateImgFromSymbolN

(   symbolName :STRING;     width :INTEGER;     height :INTEGER;     margin :INTEGER;     renderMode :INTEGER;     view :INTEGER;     component :INTEGER ) :HANDLE ;

Python:

def  vs.CreateImgFromSymbolN(symbolName, width, height, margin, renderMode, view, component):

   return HANDLE

Description:

Creates an image from the specified symbol in the specified rendering mode and view, and uses the specified component of the image.

Table - Render Modes

Render Mode	Constant
Wireframe	0
Unshaded Polygon	2
Shaded Polygon	3
Shaded Polygon No Lines	4
Final Shaded Polygon	5
Hidden Line	6
Dashed Hidden Line	7
OpenGL	11
Fast RenderWorks	12
Fast RenderWorks with Shadows	13
Final Quality RenderWorks	14
Custom RenderWorks	15
Artistic RenderWorks	17
Sketch	18

Table - Views

View	Constant
Top/Plan	2
Front	3
Back	4
Left	5
Right	6
Top	7
Bottom	8
Right Isometric	9
Left Isometric	10
Right Rear Isometric	11
Left Rear Isometric	12
Bottom Right Isometric	13
Bottom Left Isometric	14
Bottom Right Rear Isometric	15
Bottom Left Rear Isometric	16

Table - Components

Component	Constant
3D	0
2D	1
2D Cut	2
Not set	4

説明

指定したシンボルから、指定したレンダリングモードとビューで、指定したイメージのコンポーネントを使用してイメージを作成します。

Table - Render Modes

Render Mode	Constant
Wireframe	0
Unshaded Polygon	2
Shaded Polygon	3
Shaded Polygon No Lines	4
Final Shaded Polygon	5
Hidden Line	6
Dashed Hidden Line	7
OpenGL	11
Fast RenderWorks	12
Fast RenderWorks with Shadows	13
Final Quality RenderWorks	14
Custom RenderWorks	15
Artistic RenderWorks	17
Sketch	18

Table - Views

View	Constant
Top/Plan	2
Front	3
Back	4
Left	5
Right	6
Top	7
Bottom	8
Right Isometric	9
Left Isometric	10
Right Rear Isometric	11
Left Rear Isometric	12
Bottom Right Isometric	13
Bottom Left Isometric	14
Bottom Right Rear Isometric	15
Bottom Left Rear Isometric	16

Table - Components

Component	Constant
3D	0
2D	1
2D Cut	2
Not set	4

Parameters:

symbolName	The name of the symbol to display.	シンボルの表示名
width	The width of the symbol to display.	表示枠の幅
height	The height of the symbol to display.	表示枠の高さ
margin	The margin of the symbol to display.	表示枠とシンボルの間隔
renderMode	The render mode in which to display the symbol.	レンダリングモード
view	The standard view in which to display the symbol.	ビュー
component	Image component to use.	コンポーネント

Result:

Returns the handle to the newly create image resource if successful; NULL otherwise.

返り値

成功した場合、イメージのハンドルを返します。それ以外は、NULLを返します。

See Also:

CreateImgFromSymbol  

VectorScript Declaration:

FUNCTION   CreateTile

( tileName:DYNARRAY[] of CHAR ) :HANDLE ;

Python:

def  vs.CreateTile(tileName):

   return HANDLE

Description:

Creates a new tile resource.

説明

タイルを新規に作成します。

Parameters:

tileName

A user-specified name by which the newly created tile will be identified.

タイルの名称

Result:

Returns a handle to a new tile resource if successful, otherwise the function returns nil.

返り値

タイルが新規作成されたら、ハンドルを返します。作成が成功しなかったら、NILを返します。

Example:

tileHandle := CreateTile('My Tile');

See Also:

CreateTile   ShowEditTileDialog   ShowEditTileSettingsDialog   ShowNewTileDialog   GetTileGeometryGroup   BeginGroupN   AddTileGeometryObject   GetTileGroupParent   IsTileGroupContainedObject   GetTileBackgroundColor   SetTileBackgroundColor   GetTileRepetitionPoint   SetTileRepetitionPoint   GetTileOffsetPoint   SetTileOffsetPoint  

VectorScript Declaration:

FUNCTION   DefDrpShadowEnabled

:BOOLEAN ;

Python:

def  vs.DefDrpShadowEnabled():

   return BOOLEAN

VectorScript Declaration:

FUNCTION   DocDropShadowByCls

:BOOLEAN ;

Python:

def  vs.DocDropShadowByCls():

   return BOOLEAN

VectorScript Declaration:

FUNCTION   DS_GetAngle

:REAL ;

Python:

def  vs.DS_GetAngle():

   return REAL

Description:

Returns document shadow angle.

説明

書類の影の角度を返します。

VectorScript Declaration:

PROCEDURE   DS_GetFillStyle

( VAR  shadowFillStyle :INTEGER;   VAR  shadowFillName :STRING;   VAR  solidColorRef :LONGINT ) ;

Python:

def  vs.DS_GetFillStyle():

   return (shadowFillStyle, shadowFillName, solidColorRef)

Description:

Returns document shadow fill style, fill name or color index.

説明

書類の、影の面属性、面属性の名前、あるいは色インデックスを返します。

VectorScript Declaration:

FUNCTION   DS_GetOffset

:REAL ;

Python:

def  vs.DS_GetOffset():

   return REAL

Description:

Returns document shadow offset.

説明

書類の影のオフセットを返します

VectorScript Declaration:

FUNCTION   DS_GetOffsetUnit

:INTEGER ;

Python:

def  vs.DS_GetOffsetUnit():

   return INTEGER

Description:

Returns document shadow offset unit.

説明

書類の影のオフセットの単位を返します

VectorScript Declaration:

FUNCTION   DS_GetOpacity

:LONGINT ;

Python:

def  vs.DS_GetOpacity():

   return LONGINT

Description:

Returns document shadow opacity.

説明

書類の影の不透明度を返します。

VectorScript Declaration:

FUNCTION   DS_IsOpacityByClass

:BOOLEAN ;

Python:

def  vs.DS_IsOpacityByClass():

   return BOOLEAN

Description:

Returns whether document shadow opacity is by class.

説明

書類の影の不透明度がクラスによるかどうかを返します。

VectorScript Declaration:

FUNCTION   DS_IsUnderCanopy

:BOOLEAN ;

Python:

def  vs.DS_IsUnderCanopy():

   return BOOLEAN

Description:

Returns whether document shadow is under Canopy.

説明

ファイル設定で、影が樹冠の下に表示されるかどうかを返します。

VectorScript Declaration:

PROCEDURE   EnableDefDropShadow

( bEnable:BOOLEAN ) ;

Python:

def  vs.EnableDefDropShadow(bEnable):

   return None

VectorScript Declaration:

PROCEDURE   FFillBack

( VAR  red :LONGINT;   VAR  green :LONGINT;   VAR  blue :LONGINT ) ;

Python:

def  vs.FFillBack():

   return (red, green, blue)

Description:

Procedure FFillBack returns the current fill background color. RGB values are in the range of 0~65535.

説明

現在設定されている面の地色の成分を返します。値の範囲は0から65535までです。

Parameters:

red	Returns RGB color component value.	赤の成分
green	Returns RGB color component value.	緑の成分
blue	Returns RGB color component value.	青の成分

Example:

FFillBack(redValue,greenValue,blueValue);

See Also:

RGBToColorIndex   ColorIndexToRGB  

VectorScript Declaration:

FUNCTION   FFillColorByClass

:BOOLEAN ;

Python:

def  vs.FFillColorByClass():

   return BOOLEAN

Description:

Function FFillColorByClass returns whether the global attributes are set to use the fill colors of the default class.

説明

現在設定されている面の色に、クラス属性を使っている場合はTRUEを返します。

Example:

useClassFillCol:=FFillColorByClass;

VectorScript Declaration:

PROCEDURE   FFillFore

( VAR  red :LONGINT;   VAR  green :LONGINT;   VAR  blue :LONGINT ) ;

Python:

def  vs.FFillFore():

   return (red, green, blue)

Description:

Procedure FFillFore returns the current fill foreground color. RGB values are in the range of 0~65535.

説明

現在設定されている面の色の成分を返します。値の範囲は0から65535までです。

Parameters:

red	Returns RGB color component value.	赤の成分
green	Returns RGB color component value.	緑の成分
blue	Returns RGB color component value.	青の成分

Example:

FFillFore(redValue,greenValue,blueValue);

See Also:

RGBToColorIndex   ColorIndexToRGB  

VectorScript Declaration:

FUNCTION   FFillPat

:LONGINT ;

Python:

def  vs.FFillPat():

   return LONGINT

Description:

Function FFillPat returns the current fill pattern setting.

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

説明

現在設定されている模様番号を返します。

Example:

currFillStyle:=FFillPat;

VectorScript Declaration:

FUNCTION   FFPatByClass

:BOOLEAN ;

Python:

def  vs.FFPatByClass():

   return BOOLEAN

Description:

Function FFPatByClass returns whether the global attributes are set to use the fill pattern of the default class.

説明

現在設定されている面の模様に、クラス属性を使っている場合はTRUEを返します。

Example:

useClassFPat:=FFPatByClass;

VectorScript Declaration:

PROCEDURE   FillBack

(   colorR :LONGINT;     colorG :LONGINT;     colorB :LONGINT ) ;

Python:

def  vs.FillBack(color):

   return None

Description:

Procedure FillBack sets the active fill background color setting for the document. RGB values are in the range of 0~65535.

説明

現在設定されている面の地色を変更します。値の範囲は0から65535までです。

Parameters:

color

RGB color value to set as active fill background color.

赤、緑、青の成分

Example:

FillBack(65535,0,39321);

See Also:

RGBToColorIndex   ColorIndexToRGB  

VectorScript Declaration:

PROCEDURE   FillFore

(   colorR :LONGINT;     colorG :LONGINT;     colorB :LONGINT ) ;

Python:

def  vs.FillFore(color):

   return None

Description:

Procedure FillFore sets the active fill foreground color setting for the document. RGB values are in the range of 0~65535.

説明

現在設定されている面の色を変更します。値の範囲は0から65535までです。

Parameters:

color

RGB color value to set as active fill foreground color.

赤、緑、青の成分

Example:

FillFore(65535,0,39321);

See Also:

RGBToColorIndex   ColorIndexToRGB  

VectorScript Declaration:

PROCEDURE   FillPat

( patNumber:LONGINT ) ;

Python:

def  vs.FillPat(patNumber):

   return None

Description:

Procedure FillPat sets the active fill pattern for the document. Any objects created after a calling this procedure will use the specified fill pattern.

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

説明

アクティブな面の模様を設定します。この手続きの後に作成された図形は指定した面の模様が使われます。

Parameters:

patNumber

Index of fill pattern to be set as document default.

模様番号

Example:

Rect(0,0,2,2);
FillPat(21);
Rect(2,2,4,4);

VectorScript Declaration:

FUNCTION   FLSByClass

:BOOLEAN ;

Python:

def  vs.FLSByClass():

   return BOOLEAN

Description:

Function FLSByClass returns whether the global attributes are set to use the line style of the default class.

説明

現在設定されている線の種類に、クラス属性を使っている場合はTRUEを返します。

Example:

useClassLStyle:=FLSByClass;

VectorScript Declaration:

FUNCTION   FLWByClass

:BOOLEAN ;

Python:

def  vs.FLWByClass():

   return BOOLEAN

Description:

Function FLWByClass returns whether the global attributes are set to use the line weight of the default class.

説明

現在設定されている線の太さに、クラス属性を使っている場合はTRUEを返します。

Example:

useClassLWidth:=FLWByClass;

VectorScript Declaration:

PROCEDURE   FMarker

( VAR  style :INTEGER;   VAR  size :REAL;   VAR  ang :INTEGER ) ;

Python:

def  vs.FMarker():

   return (style, size, ang)

Special Notes:

FMarker is obsolete as of VectorWorks 2008

Description:

Procedure FMarker returns the active marker style parameters.

A complete listing of marker styles can be found in the Appendix

説明

現在設定されているマーカスタイル、長さ（インチ）、角度（度数）を返します。

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

Parameters:

style	Returns marker style.	スタイル
size	Returns marker size in inches measured in page space.	長さ（インチ）
ang	Returns marker angle (in degrees).	角度（度数）

Example:

PROCEDURE Example;
VAR
	style :INTEGER;
	size  :REAL;
	ang   :INTEGER;
BEGIN
	FMarker(style, size, ang);
	Message(style, ' ', size, ' ', ang);
END;
RUN(Example);

VectorScript Declaration:

FUNCTION   FMarkerByClass

:BOOLEAN ;

Python:

def  vs.FMarkerByClass():

   return BOOLEAN

Description:

Function FMarkerByClass returns whether the global attributes are set to use the arrow style of the default class.

説明

現在設定されているマーカの種類に、クラス属性を使っている場合はTRUEを返します。

Example:

useClassMarker:=FMarkerByClass;

VectorScript Declaration:

PROCEDURE   FPenBack

( VAR  red :LONGINT;   VAR  green :LONGINT;   VAR  blue :LONGINT ) ;

Python:

def  vs.FPenBack():

   return (red, green, blue)

Description:

Procedure FPenBack returns the current pen background color. RGB values are in the range of 0~65535.

説明

現在設定されている線の地色の成分を返します。値の範囲は0から65535までです。

Parameters:

red	Returns RGB color component value.	赤の成分
green	Returns RGB color component value.	緑の成分
blue	Returns RGB color component value.	青の成分

See Also:

RGBToColorIndex   ColorIndexToRGB  

VectorScript Declaration:

FUNCTION   FPenColorByClass

:BOOLEAN ;

Python:

def  vs.FPenColorByClass():

   return BOOLEAN

Description:

Function FPenColorByClass returns whether the global attributes are set to use the pen colors of the default class.

説明

現在設定されている線の色に、クラス属性を使っている場合はTRUEを返します。

Example:

useClassPenColor:=FPenColorByClass;

VectorScript Declaration:

PROCEDURE   FPenFore

( VAR  red :LONGINT;   VAR  green :LONGINT;   VAR  blue :LONGINT ) ;

Python:

def  vs.FPenFore():

   return (red, green, blue)

Description:

Procedure FPenFore returns the current pen foreground color of the document. RGB values are in the range of 0~65535.

説明

現在設定されている線の色成分を返します。値の範囲は0から65535までです。

Parameters:

red	Returns RGB color component value.	赤の成分
green	Returns RGB color component value.	緑の成分
blue	Returns RGB color component value.	青の成分

See Also:

RGBToColorIndex   ColorIndexToRGB  

VectorScript Declaration:

FUNCTION   FPenPat

:INTEGER ;

Python:

def  vs.FPenPat():

   return INTEGER

Special Notes:

FPenPat is obsolete as of Vectorworks 2013

Description:

Deprecated - will generate error. Use FPenPatN instead.

説明

現在設定されている線の模様を返します。

Example:

CurrPenStyle:=FPenPat;

See Also:

FPenPatN  

VectorScript Declaration:

FUNCTION   FPenPatN

:LONGINT ;

Python:

def  vs.FPenPatN():

   return LONGINT

Description:

Function FPenPatN returns the active pen pattern setting.

説明

現在設定されている線の模様を返します。

See Also:

PenPatN  

VectorScript Declaration:

FUNCTION   FPenSize

:INTEGER ;

Python:

def  vs.FPenSize():

   return INTEGER

Description:

Function FPenSize returns the active pen size setting (in mils).

説明

現在設定されている線の太さを返します。

Example:

CurrPenSize:=FPenSize;

VectorScript Declaration:

FUNCTION   GetDashDataValPairAt

(   dashStyleIndex :INTEGER;     dataIndex :INTEGER;   VAR  dash :REAL;   VAR  gap :REAL ) :BOOLEAN ;

Python:

def  vs.GetDashDataValPairAt(dashStyleIndex, dataIndex):

   return (BOOLEAN, dash, gap)

Special Notes:

GetDashDataValPairAt is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use GetDashDataValPrAtN instead.

説明

指定した破線の種類の破線データを返します。 破線データは破線／間隔のペアです。 破線の種類や破線データがない場合はFalseを返します。 破線の種類では破線／間隔のペアを5つまで指定できます。

Parameters:

dashStyleIndex	The dash style index.	破線の種類のインデックス
dataIndex	Index fo the data value pair.	破線データのインデックス
dash	The dash segement value.	破線の長さ
gap	The gap segment value.	間隔の長さ

Example:

The dash-related functions here have been deprecated and will return errors. 
PROCEDURE Example;
VAR
n, numPairs, dashIndex : INTEGER;
scaleWThick  :BOOLEAN;
arrayDashDat : ARRAY[1..5] OF POINT;
x,y : REAL;

BEGIN

dashIndex := GetDashStyleIndex(TRUE, 2, 0.12, 0.18, 0.03, 0.07);

numPairs := GetNumDashDataPairs(dashIndex,scaleWThick);

FOR n := 1 TO numPairs DO BEGIN
 IF (GetDashDataValPairAt(dashIndex, n , x, y)) THEN BEGIN
   arrayDashDat[n].x := x ;
   arrayDashDat[n].y := y ;
 END; 
END;

END;
RUN(Example);

See Also:

GetDashDataValPrAtN  

VectorScript Declaration:

FUNCTION   GetDashDataValPrAtN

(   dashStyleIndex :LONGINT;     dataIndex :INTEGER;   VAR  dash :REAL;   VAR  gap :REAL ) :BOOLEAN ;

Python:

def  vs.GetDashDataValPrAtN(dashStyleIndex, dataIndex):

   return (BOOLEAN, dash, gap)

Description:

Function GetDashDataValPrAtN gets the dash data for the specified dash style. The dash data is a dash/gap value pair. GetDashDataValPrAtN returns false if the dash style or dash data doesn't exist. Dash styles support up to 5 dash/gap value pairs.

説明

指定した破線の種類の破線データを返します。 破線データは破線/間隔のペアです。 破線の種類や破線データがない場合はFalseを返します。 破線の種類では破線/間隔のペアを5つまで指定できます。

Parameters:

dashStyleIndex	The negative value of the dash pattern's internal index.	破線の種類のインデックス(負の値)
dataIndex	Index of the data value pair.	破線/間隔データの番号
dash	The dash segement value.	破線データの値
gap	The gap segment value.	間隔データの値

Example:

PROCEDURE Example;
VAR
n, numPairs : INTEGER;
dashIndex : LONGINT;
scaleWThick  :BOOLEAN;
arrayDashDat : ARRAY[1..5] OF POINT;
x,y : REAL;

BEGIN

dashIndex := GetDashStyleIndexN(TRUE, 2, 0.12, 0.18, 0.03, 0.07);

numPairs := GetNumDashDataPairsN(dashIndex,scaleWThick);

FOR n := 1 TO numPairs DO BEGIN
 IF (GetDashDataValPrAtN(dashIndex, n , x, y)) THEN BEGIN
   arrayDashDat[n].x := x ;
   arrayDashDat[n].y := y ;
 END; 
END;

END;
RUN(Example);

See Also:

GetNumDashDataPairsN   GetDashStyleIndexN  

VectorScript Declaration:

FUNCTION   GetDashStyle

(   swt :BOOLEAN;     numPairs :INTEGER;     pair1DX :REAL;     pair1DY :REAL;     pair2DX :REAL;     pair2DY :REAL;     pair3DX :REAL;     pair3DY :REAL;     pair4DX :REAL;     pair4DY :REAL;     pair5DX :REAL;     pair5DY :REAL ) :INTEGER ;

Python:

def  vs.GetDashStyle(swt, numPairs, pair1, pair2, pair3, pair4, pair5):

   return INTEGER

Special Notes:

GetDashStyle is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use GetDashStyleN instead.

説明

現在設定されている破線の種類を返します。

Example:

currLS:=GetDashStyle;

See Also:

GetDashStyleN  

VectorScript Declaration:

FUNCTION   GetDashStyleIndex

(   swt :BOOLEAN;     numPairs :INTEGER;     pair1DX :REAL;     pair1DY :REAL;     pair2DX :REAL;     pair2DY :REAL;     pair3DX :REAL;     pair3DY :REAL;     pair4DX :REAL;     pair4DY :REAL;     pair5DX :REAL;     pair5DY :REAL ) :INTEGER ;

Python:

def  vs.GetDashStyleIndex(swt, numPairs, pair1, pair2, pair3, pair4, pair5):

   return INTEGER

Special Notes:

GetDashStyleIndex is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use GetDashStyleIndexN instead.

説明

現在設定されている破線の名前と種類を返します。

Example:

GetDashStyleIndex(TRUE, 2, 0.12, 0.18, 0.03, 0.07);

GetDashStyleIndex(TRUE, 3, 0.12, 0.18, 0.03, 0.07, 0.2, 0.05);

See Also:

GetDashStyleIndexN  

VectorScript Declaration:

FUNCTION   GetDashStyleIndexN

(   swt :BOOLEAN;     numPairs :INTEGER;     pair1DX :REAL;     pair1DY :REAL;     pair2DX :REAL;     pair2DY :REAL;     pair3DX :REAL;     pair3DY :REAL;     pair4DX :REAL;     pair4DY :REAL;     pair5DX :REAL;     pair5DY :REAL ) :LONGINT ;

Python:

def  vs.GetDashStyleIndexN(swt, numPairs, pair1, pair2, pair3, pair4, pair5):

   return LONGINT

Description:

Function GetDashStyleIndexN searches for the pattern specified by the parameters. If it exists, then the negative value of the dash pattern's internal index is returned. If it does not exist, then it is added to the document and the negative value of the new dash pattern's internal index is returned.

説明

パラメータで指定した破線パターンを探します。存在する場合は破線の負の値の内部インデックス番号を返します。存在しない場合は、ファイルにその破線を追加し、新しい破線の負の値の内部インデックス番号を返します。

Example:

GetDashStyleIndexN(TRUE, 2, 0.12, 0.18, 0.03, 0.07);

GetDashStyleIndexN(TRUE, 3, 0.12, 0.18, 0.03, 0.07, 0.2, 0.05);

See Also:

GetDashDataValPrAtN   GetNumDashDataPairsN  

VectorScript Declaration:

FUNCTION   GetDashStyleN

(   swt :BOOLEAN;     numPairs :INTEGER;     pair1DX :REAL;     pair1DY :REAL;     pair2DX :REAL;     pair2DY :REAL;     pair3DX :REAL;     pair3DY :REAL;     pair4DX :REAL;     pair4DY :REAL;     pair5DX :REAL;     pair5DY :REAL ) :LONGINT ;

Python:

def  vs.GetDashStyleN(swt, numPairs, pair1, pair2, pair3, pair4, pair5):

   return LONGINT

Description:

Function GetDashStyleN searches for the pattern specified by the parameters. If it exists, then the negative value of the dash pattern's internal index is returned. If it does not exist, then it is added to the document and the negative value of the dash pattern's internal index is returned.

説明

パラメータで指定した破線パターンを探します。存在する場合は破線の負の値の内部インデックス番号を返します。存在しない場合は、ファイルにその破線を追加し、破線の負の値の内部インデックス番号を返します。

Example:

currLS:=GetDashStyleN;

VectorScript Declaration:

FUNCTION   GetDefaultBeginningMarker

( 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.GetDefaultBeginningMarker():

   return (BOOLEAN, style, angle, size, width, thicknessBasis, thickness, visibility)

Description:

Gets all properties for the document default beginning marker. Return TRUE if operation was successful.

説明

ファイルのデフォルト始点マーカのすべての設定値を返します。正常終了するとTRUEが返されます。

Parameters:

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;
style: INTEGER;
	angle: INTEGER;
	size: REAL;
	width: REAL;
	thickBasis: INTEGER;
	thickness: REAL;
	visibility: BOOLEAN;

	
BEGIN
ok := GetDefaultBeginningMarker (style, angle, size, width, thickBasis, thickness, visibility);
Message (style, ' /  ', angle, '  /  ', size, '  /  ', width, ' /  ', thickBasis, ' /  ', thickness, ' /  ', visibility);	
END;

RUN(Example);

See Also:

GetDefaultEndMarker  

VectorScript Declaration:

FUNCTION   GetDefaultEndMarker

( 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.GetDefaultEndMarker():

   return (BOOLEAN, style, angle, size, width, thicknessBasis, thickness, visibility)

Description:

Gets all properties for the document default end marker. Return TRUE if operation was successful.

説明

ファイルのデフォルト終点マーカのすべての設定値を返します。正常終了するとTRUEが返されます。

Parameters:

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;
style: INTEGER;
	angle: INTEGER;
	size: REAL;
	width: REAL;
	thickBasis: INTEGER;
	thickness: REAL;
	visibility: BOOLEAN;

	
BEGIN
ok := GetDefaultEndMarker (style, angle, size, width, thickBasis, thickness, visibility);
Message (style, ' /  ', angle, '  /  ', size, '  /  ', width, ' /  ', thickBasis, ' /  ', thickness, ' /  ', visibility);	
END;

RUN(Example);

See Also:

GetDefaultBeginningMarker  

VectorScript Declaration:

PROCEDURE   GetDefaultOpacity

( VAR opacity:INTEGER ) ;

Python:

def  vs.GetDefaultOpacity():

   return opacity

Description:

Returns the default opacity.

説明

デフォルトの不透明度に返します。

VectorScript Declaration:

PROCEDURE   GetDefaultOpacityN

( VAR  outPenOpacity :INTEGER;   VAR  outFillOpacity :INTEGER ) ;

Python:

def  vs.GetDefaultOpacityN():

   return (outPenOpacity, outFillOpacity)

VectorScript Declaration:

PROCEDURE   GetDefOpacityByClsN

( VAR  outDefFillOpacityByClass :BOOLEAN;   VAR  outDefPenOpacityByClass :BOOLEAN ) ;

Python:

def  vs.GetDefOpacityByClsN():

   return (outDefFillOpacityByClass, outDefPenOpacityByClass)

VectorScript Declaration:

PROCEDURE   GetDocDrpShadowData

( VAR  bUseDropShadow :BOOLEAN;   VAR  nUnits :INTEGER;   VAR  dOffset :REAL;   VAR  dBlurRadius :REAL;   VAR  dAngle :REAL;   VAR  nOpacity :INTEGER;   VAR  colorRV :INTEGER;   VAR  colorGV :INTEGER;   VAR  colorBV :INTEGER ) ;

Python:

def  vs.GetDocDrpShadowData():

   return (bUseDropShadow, nUnits, dOffset, dBlurRadius, dAngle, nOpacity, colorRV, colorGV, colorBV)

VectorScript Declaration:

FUNCTION   GetDocumentDefaultSketchStyle

:STRING ;

Python:

def  vs.GetDocumentDefaultSketchStyle():

   return STRING

Description:

Returns the document default sketch style. Returns the string 'No Sketch' if the current sketch style is 'No Sketch'.

説明

ドキュメントデフォルトのスケッチスタイルを返します。
ドキュメントデフォルトのスケッチスタイルが「スケッチなし」であれば、「スケッチなし」という文字列を返します。

VectorScript Declaration:

PROCEDURE   GetGradientData

(   gradient :HANDLE;     segmentIndex :INTEGER;   VAR  spotPosition :REAL;   VAR  midpointPosition :REAL;   VAR  red :LONGINT;   VAR  green :LONGINT;   VAR  blue :LONGINT ) ;

Python:

def  vs.GetGradientData(gradient, segmentIndex):

   return (spotPosition, midpointPosition, red, green, blue)

Description:

Gets the spot position, midpoint position and color of the specified gradient segment.

説明

変化位置の変化点、変化の中心点の位置と色を返します。

Parameters:

gradient	Gradient that contains the segment.	グラデーションのハンドル
segmentIndex	Segment from which to get the data. (segment indexes begin with 1)	変化位置番号（最も左を1とする）
spotPosition	Position of the segment's color spot relative to left-most point of the gradient. (position >= 0.0 and position <= 1.0)	変化点の位置（0.0以上1.0以下）
midpointPosition	Position of the segment's midpoint relative to color spot immediately to left. (position >= 0.0 and position <= 1.0)	変化の中心点の位置（0.0以上1.0以下）
red	Red component of the color spot's color. (red >= 0 and red <= 255)	変化点の色の赤成分（0以上255以下）
green	Green component of the color spot's color. (green >= 0 and green <= 255)	変化点の色の緑成分（0以上255以下）
blue	Blue component of the color spot's color. (blue >= 0 and blue <= 255)	変化点の色の青成分（0以上255以下）

Example:

PROCEDURE Example;
VAR
   gradient :HANDLE;
   segmentIndex :INTEGER;
   spotPosition, midpointPosition :REAL;
   red, green, blue :LONGINT;
BEGIN
   gradient := GetObject('Cyan-Magenta-Yellow');
   segmentIndex := 3;
   GetGradientData(gradient, segmentIndex, spotPosition, midpointPosition, red, green, blue);
   Message(red, ' ', green, ' ', blue);
END;
RUN(Example);

VectorScript Declaration:

PROCEDURE   GetGradientDataN

(   gradient :HANDLE;     segmentIndex :INTEGER;   VAR  spotPosition :REAL;   VAR  midpointPosition :REAL;   VAR  red :LONGINT;   VAR  green :LONGINT;   VAR  blue :LONGINT;   VAR  opacity :INTEGER ) ;

Python:

def  vs.GetGradientDataN(gradient, segmentIndex):

   return (Boolean, spotPosition, midpointPosition, red, green, blue, opacity)

Parameters:

gradient	Gradient that contains the segment.	グラデーションのハンドル
segmentIndex	Segment from which to get the data.	変化位置番号（最も左を1とする）
spotPosition	Position of the segment's color spot relative to left-most point of the gradient.	変化点の位置
midpointPosition	Position of the segment's midpoint relative to color spot immediately to left.	変化の中心点の位置
red	Red component of the color spot's color.	変化点の色の赤成分
green	Green component of the color spot's color.	変化点の色の緑成分
blue	Blue component of the color spot's color.	変化点の色の青成分
opacity	Opacity of the color spot.	変化点の色の不透明度

Example:

PROCEDURE Example;
VAR
gradient :HANDLE;
segmentIndex :INTEGER;
spotPosition, midpointPosition :REAL;
red, green, blue :LONGINT;
opacity :INTEGER
BEGIN
gradient := GetObject('Cyan-Magenta-Yellow');
segmentIndex := 3;
GetGradientData(gradient, segmentIndex, spotPosition, midpointPosition, red, green, blue.opacity);
Message(red, ' ', green, ' ', blue, ' ', opacity);
END;
RUN(Example);

See Also:

SetGradientDataN   InsertGradientData  

VectorScript Declaration:

PROCEDURE   GetGradientMidpointPosition

(   gradient :HANDLE;     segmentIndex :INTEGER;   VAR  position :REAL ) ;

Python:

def  vs.GetGradientMidpointPosition(gradient, segmentIndex):

   return position

Description:

Gets the midpoint position of the specified gradient segment.

説明

変化位置の変化の中心点の位置を返します。

Parameters:

gradient	Gradient that contains the segment.	グラデーションのハンドル
segmentIndex	Segment from which to get the data. (segment indexes begin with 1)	変化位置番号（最も左を1とする）
position	Position of the segment's midpoint relatvie to color spot immediately to left. (position >= 0.0 and position <= 1.0)	変化の中心点の位置（0.0以上1.0以下）

Example:

GetGradientMidpointPosition(gradientHandle, 4, midpointPosition);

VectorScript Declaration:

PROCEDURE   GetGradientOpacity

(   gradient :HANDLE;     segmentIndex :INTEGER;   VAR  opacity :INTEGER ) ;

Python:

def  vs.GetGradientOpacity(gradient, segmentIndex):

   return opacity

Parameters:

gradient	Gradient that contains the segment.	グラデーションのハンドル
segmentIndex	Segment from which to get the data.	変化位置番号（最も左を1とする）
opacity	Opacity at the spot position.	変化点の色の不透明度

Example:

GetGradientOpacity(gradientHandle, 4, opacity);

See Also:

SetGradientOpacity  

VectorScript Declaration:

PROCEDURE   GetGradientSpotColor

(   gradient :HANDLE;     segmentIndex :INTEGER;   VAR  red :LONGINT;   VAR  green :LONGINT;   VAR  blue :LONGINT ) ;

Python:

def  vs.GetGradientSpotColor(gradient, segmentIndex):

   return (red, green, blue)

Description:

Gets the spot color of the specified gradient segment.

説明

変化位置の変化点の色を返します。

Parameters:

gradient	Gradient that contains the segment.	グラデーションのハンドル
segmentIndex	Segment from which to get the data. (segment indexes begin with 1)	変化位置番号（最も左を1とする）
red	Red component of the color spot's color. (red >= 0 and red <= 255)	変化点の色の赤成分（0以上255以下）
green	Green component of the color spot's color. (green >= 0 and green <= 255)	変化点の色の緑成分（0以上255以下）
blue	Blue component of the color spot's color. (blue >= 0 and blue <= 255)	変化点の色の青成分（0以上255以下）

Example:

GetGradientSpotColor(gradientHandle, 4, red, green, blue);

VectorScript Declaration:

PROCEDURE   GetGradientSpotPosition

(   gradient :HANDLE;     segmentIndex :INTEGER;   VAR  position :REAL ) ;

Python:

def  vs.GetGradientSpotPosition(gradient, segmentIndex):

   return position

Description:

Gets the spot position of the specified gradient segment.

説明

変化位置の変化点の位置を返します。

Parameters:

gradient	Gradient that contains the segment.	グラデーションのハンドル
segmentIndex	Segment from which to get the data. (segment indexes begin with 1)	変化位置番号（最も左を1とする）
position	Position of the segment's color spot relative to left-most point of the gradient. (position >= 0.0 and position <= 1.0)	変化点の位置（0.0以上1.0以下）

Example:

GetGradientSpotPosition(gradientHandle, 4, spotPosition);

VectorScript Declaration:

FUNCTION   GetNumDashDataPairs

(   dashIndex :INTEGER;   VAR  swt :BOOLEAN ) :INTEGER ;

Python:

def  vs.GetNumDashDataPairs(dashIndex):

   return (INTEGER, swt)

Special Notes:

GetNumDashDataPairs is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use GetNumDashDataPairsN instead.

説明

指定した破線の種類で定義されている、破線／間隔のペアの数を返します。 線の太さに連動しているかどうかも返します。 破線／間隔のペアは最大で5組です。

Parameters:

dashIndex	The dash style index.	破線の種類のインデックス
swt	The "scale with thickness" setting.	線の太さに連動している(TRUE)／していない(FALSE)

Example:

The dash-related functions here have been deprecated and will return errors. 
PROCEDURE Example;
VAR
n, numPairs, dashIndex : INTEGER;
scaleWThick  :BOOLEAN;
arrayDashDat : ARRAY[1..5] OF POINT;
x,y : REAL;

BEGIN

dashIndex := GetDashStyleIndex(TRUE, 2, 0.12, 0.18, 0.03, 0.07);

numPairs := GetNumDashDataPairs(dashIndex,scaleWThick);

FOR n := 1 TO numPairs DO BEGIN
 IF (GetDashDataValPairAt(dashIndex, n , x, y)) THEN BEGIN
   arrayDashDat[n].x := x ;
   arrayDashDat[n].y := y ;
 END; 
END;

END;
RUN(Example);

See Also:

GetNumDashDataPairsN   

VectorScript Declaration:

FUNCTION   GetNumDashDataPairsN

(   dashIndex :LONGINT;   VAR  swt :BOOLEAN ) :INTEGER ;

Python:

def  vs.GetNumDashDataPairsN(dashIndex):

   return (INTEGER, swt)

Description:

Function GetNumDashDataPairsN returns the number of dash/gap value pairs defined for the specified dash style. The "scale with thickness" setting is also returned. Dash styles support up to 5 dash/gap value pairs.

説明

指定した破線の種類で定義されている、破線/間隔のペアの数を返します。 線の太さに連動しているかどうかも返します。 破線/間隔のペアは最大で5組です。

Parameters:

dashIndex	The negative value of the dash pattern's internal index.	破線の種類のインデックス(負の値)
swt	The "scale with thickness" setting.	線の太さに連動するかどうか

Example:

PROCEDURE Example;
VAR
n, numPairs : INTEGER;
dashIndex : LONGINT;
scaleWThick  :BOOLEAN;
arrayDashDat : ARRAY[1..5] OF POINT;
x,y : REAL;

BEGIN

dashIndex := GetDashStyleIndexN(TRUE, 2, 0.12, 0.18, 0.03, 0.07);

numPairs := GetNumDashDataPairsN(dashIndex,scaleWThick);

FOR n := 1 TO numPairs DO BEGIN
 IF (GetDashDataValPrAtN(dashIndex, n , x, y)) THEN BEGIN
   arrayDashDat[n].x := x ;
   arrayDashDat[n].y := y ;
 END; 
END;

END;
RUN(Example);

See Also:

GetDashDataValPrAtN   GetDashStyleIndexN  

VectorScript Declaration:

FUNCTION   GetNumGradientSegments

( gradient:HANDLE ) :INTEGER ;

Python:

def  vs.GetNumGradientSegments(gradient):

   return INTEGER

Description:

Gets the number of segments in the gradient.

説明

グラデーションの変化位置の数を返します。

Parameters:

gradient

The gradient from which to get the number of segments.

グラデーションのハンドル

Result:

Returns the number of segments in the gradient if successful; 0 otherwise.

返り値

グラデーションの変化位置の数を返します。変化位置の数を取得できなかった場合は0を返します。

Example:

numSegments := GetNumGradientSegments(gradientHandle);

VectorScript Declaration:

PROCEDURE   GetTileBackgroundColor

(   tileHandle :HANDLE;   VAR  red :LONGINT;   VAR  green :LONGINT;   VAR  blue :LONGINT ) ;

Python:

def  vs.GetTileBackgroundColor(tileHandle):

   return (red, green, blue)

Description:

Gets the specified tile resource's background color.

説明

指定したタイルリソースの背景色を取得します。

Parameters:

tileHandle	The tile resource from which to get the background color.	タイルリソースのハンドル
red	Returns RGB color component value.	赤色の成分
green	Returns RGB color component value.	緑色の成分
blue	Returns RGB color component value.	青色の成分

Example:

GetTileBackgroundColor(tileHandle, backgroundColor);

See Also:

CreateTile   ShowEditTileDialog   ShowEditTileSettingsDialog   ShowNewTileDialog   GetTileGeometryGroup   BeginGroupN   AddTileGeometryObject   GetTileGroupParent   IsTileGroupContainedObject   GetTileBackgroundColor   SetTileBackgroundColor   GetTileRepetitionPoint   SetTileRepetitionPoint   GetTileOffsetPoint   SetTileOffsetPoint  

VectorScript Declaration:

FUNCTION   GetTileGeometryGroup

( tileHandle:HANDLE ) :HANDLE ;

Python:

def  vs.GetTileGeometryGroup(tileHandle):

   return HANDLE

Description:

Gets the tile resource's geometry group.

説明

タイルリソースの形状グループを取得します。

Parameters:

tileHandle

The handle to the tile from which to get the group.

タイルリソースのハンドル

Result:

A handle to the tile geometry group, if successful; nil otherwise.

返り値

タイルリソースのグループハンドル

Example:

tileGroupHandle := GetTileGeometryGroup(tileHandle);

See Also:

CreateTile   ShowEditTileDialog   ShowEditTileSettingsDialog   ShowNewTileDialog   GetTileGeometryGroup   BeginGroupN   AddTileGeometryObject   GetTileGroupParent   IsTileGroupContainedObject   GetTileBackgroundColor   SetTileBackgroundColor   GetTileRepetitionPoint   SetTileRepetitionPoint   GetTileOffsetPoint   SetTileOffsetPoint  

VectorScript Declaration:

FUNCTION   GetTileGroupParent

( groupHandle:HANDLE ) :HANDLE ;

Python:

def  vs.GetTileGroupParent(groupHandle):

   return HANDLE

Description:

Gets the tile resource parent of the specified tile group.

説明

指定したタイルグループを内包するコンテナのハンドルを取得します。

Parameters:

groupHandle

The group handle of which to get the tile resource parent.

タイルリソースのグループハンドル

Result:

The tile parent handle; nil otherwise.

返り値

内包するハンドル。取得できない場合nilが返ります。

Example:

tileHandle := GetTileGroupParent(groupHandle);

See Also:

CreateTile   ShowEditTileDialog   ShowEditTileSettingsDialog   ShowNewTileDialog   GetTileGeometryGroup   BeginGroupN   AddTileGeometryObject   GetTileGroupParent   IsTileGroupContainedObject   GetTileBackgroundColor   SetTileBackgroundColor   GetTileRepetitionPoint   SetTileRepetitionPoint   GetTileOffsetPoint   SetTileOffsetPoint  

VectorScript Declaration:

PROCEDURE   GetTileOffsetPoint

(   tileHandle :HANDLE;     offsetPoint :POINT ) ;

Python:

def  vs.GetTileOffsetPoint(tileHandle):

   return offsetPoint

Description:

Gets the specified tile resource's offset point.

説明

指定したタイルリソースのオフセットポイントを取得します。

Parameters:

tileHandle	The tile resource from which to get the offset point.	タイルリソースのハンドル
offsetPoint	The retrieved offset point.	オフセット座標

Example:

GetTileOffsetPoint(tileHandle, offsetPoint);

See Also:

CreateTile   ShowEditTileDialog   ShowEditTileSettingsDialog   ShowNewTileDialog   GetTileGeometryGroup   BeginGroupN   AddTileGeometryObject   GetTileGroupParent   IsTileGroupContainedObject   GetTileBackgroundColor   SetTileBackgroundColor   GetTileRepetitionPoint   SetTileRepetitionPoint   GetTileOffsetPoint   SetTileOffsetPoint  

VectorScript Declaration:

PROCEDURE   GetTileRepetitionPoint

(   tileHandle :HANDLE;     repetitionPoint :POINT ) ;

Python:

def  vs.GetTileRepetitionPoint(tileHandle):

   return repetitionPoint

Description:

Gets the specified tile resource's repetition point.

説明

指定したタイルリソースの繰り返しポイントを取得します。

Parameters:

tileHandle	The tile resource from which to get the repetition point.	タイルリソースのハンドル
repetitionPoint	The retrieved repetition point.	繰り返し座標

Example:

GetTileRepetitionPoint(tileHandle, repetitionPoint);

See Also:

CreateTile   ShowEditTileDialog   ShowEditTileSettingsDialog   ShowNewTileDialog   GetTileGeometryGroup   BeginGroupN   AddTileGeometryObject   GetTileGroupParent   IsTileGroupContainedObject   GetTileBackgroundColor   SetTileBackgroundColor   GetTileRepetitionPoint   SetTileRepetitionPoint   GetTileOffsetPoint   SetTileOffsetPoint  

VectorScript Declaration:

FUNCTION   InsertGradientData

(   gradient :HANDLE;     spotPosition :REAL;     midpointPosition :REAL;     red :LONGINT;     green :LONGINT;     blue :LONGINT;     opacity :INTEGER ) :INTEGER ;

Python:

def  vs.InsertGradientData(gradient, spotPosition, midpointPosition, red, green, blue, opacity):

   return INTEGER

Description:

A segment consists of a single color spot and the single midpoint immediately to the right of the color spot.

説明

グラデーションに新しい変化位置を挿入し、そのデータを指定した値で初期化します。

Parameters:

gradient	Gradient into which a segment is to be inserted.	グラデーションのハンドル
spotPosition	Position of the segment's color spot relative to left-most point of the gradient.	変化点の位置（0.0以上1.0以下）
midpointPosition	Position of the segment's midpoint relative to color spot immediately to left.	変化の中心点の位置（0.0以上1.0以下）
red	Red component of the color spot's color.	変化点の色の赤成分（0以上255以下）
green	Green component of the color spot's color.	変化点の色の緑成分（0以上255以下）
blue	Blue component of the color spot's color.	変化点の色の青成分（0以上255以下）
opacity	Opacity of the color spot.	変化点の色の不透明度

Result:

Returns the index of the newly created segment; 0 otherwise.
Note: segment indexes begin with 1.

返り値

新しく作成された変化位置の番号を返します。作成できなかった場合は0を返します。
注：変化位置の番号は1から始まります。

Example:

index := InsertGradientData(gradientHandle, 0.35, 0.4, 255, 255, 255, 100);
{ inserts a white color spot at position, 0.35, with a midpoint position of 0.4; 100 is max opacity (i.e. opaque) }

See Also:

GetGradientDataN   SetGradientDataN  

VectorScript Declaration:

FUNCTION   InsertGradientSegment

(   gradient :HANDLE;     spotPosition :REAL;     midpointPosition :REAL;     red :LONGINT;     green :LONGINT;     blue :LONGINT ) :INTEGER ;

Python:

def  vs.InsertGradientSegment(gradient, spotPosition, midpointPosition, red, green, blue):

   return INTEGER

Description:

Inserts a new segment into the gradient and initializes its data to the specified values.

A segment consists of a single color spot and the single midpoint immediately to the right of the color spot.

説明

グラデーションに新しい変化位置を挿入し、そのデータを指定した値で初期化します。

変化位置は1つの変化点と、そのすぐ右にある1つの変化の中心点から構成されています。

Parameters:

gradient	Gradient into which a segment is to be inserted.	グラデーションのハンドル
spotPosition	Position of the segment's color spot relative to left-most point of the gradient. (position >= 0.0 and position <= 1.0)	変化点の位置（0.0以上1.0以下）
midpointPosition	Position of the segment's midpoint relative to color spot immediately to left. (position >= 0.0 and position <= 1.0)	変化の中心点の位置（0.0以上1.0以下）
red	Red component of the color spot's color. (red >= 0 and red <= 255)	変化点の色の赤成分（0以上255以下）
green	Green component of the color spot's color. (green >= 0 and green <= 255)	変化点の色の緑成分（0以上255以下）
blue	Blue component of the color spot's color. (blue >= 0 and blue <= 255)	変化点の色の青成分（0以上255以下）

Result:

Returns the index of the newly created segment; 0 otherwise.

Note: segment indexes begin with 1.

返り値

新しく作成された変化位置の番号を返します。作成できなかった場合は0を返します。

Example:

index := InsertGradientSegment(gradientHandle, 0.35, 0.4, 255, 255, 255);
{ inserts a white color spot at position, 0.35, with a midpoint position of 0.4 }

VectorScript Declaration:

FUNCTION   IsTileGroupContainedObject

( objectHandle:HANDLE ) :BOOLEAN ;

Python:

def  vs.IsTileGroupContainedObject(objectHandle):

   return BOOLEAN

Description:

Determines if the specified object is a tile group-contained object.

説明

指定した図形がタイルグループに含まれている/いないを返します。

Parameters:

objectHandle

The object handle to check.

調べたい図形のハンドル

Result:

TRUE if the object is a tile group-contained object; FALSE otherwise.

返り値

含まれていたらTRUEが返ります。いない場合はFALSEが返ります。

Example:

return := IsTileGroupContainedObject(objectHandle);

See Also:

CreateTile   ShowEditTileDialog   ShowEditTileSettingsDialog   ShowNewTileDialog   GetTileGeometryGroup   BeginGroupN   AddTileGeometryObject   GetTileGroupParent   IsTileGroupContainedObject   GetTileBackgroundColor   SetTileBackgroundColor   GetTileRepetitionPoint   SetTileRepetitionPoint   GetTileOffsetPoint   SetTileOffsetPoint  

VectorScript Declaration:

FUNCTION   IsUserColor

(   ColorIDX :INTEGER;   VAR  ColorName :DYNARRAY[] of CHAR ) :BOOLEAN ;

Python:

def  vs.IsUserColor(ColorIDX):

   return (BOOLEAN, ColorName)

Description:

Returns True if the color is a user color.

説明

色がユーザ色の場合は、TRUEを返します。

VectorScript Declaration:

PROCEDURE   Marker

(   style :INTEGER;     size :REAL;     ang :INTEGER ) ;

Python:

def  vs.Marker(style, size, ang):

   return None

Special Notes:

Marker is obsolete as of VectorWorks 2008

Description:

Marker defines a marker (arrowhead) style for the document. This marker style becomes the active style for the document.

A complete listing of marker styles can be found in the Appendix

説明

現在設定されているマーカスタイル、長さ（インチ）、角度（度数）を変更します。

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

Parameters:

style	Marker style constant.	スタイル
size	Marker size in inches measured in page space. Legal values are 0.0 to 2.0.	長さ（インチ）
ang	Marker angle.	角度（度数）

Example:

Marker(2,0.25,60);

VectorScript Declaration:

FUNCTION   NumColors

:INTEGER ;

Python:

def  vs.NumColors():

   return INTEGER

Description:

Returns the last used color index in the current document.

説明

現在のファイルで最後に使用した色番号を返します。

VectorScript Declaration:

FUNCTION   NumDashStyles

:INTEGER ;

Python:

def  vs.NumDashStyles():

   return INTEGER

Special Notes:

NumDashStyles is obsolete as of Vectorworks 2019

Description:

Function NumDashStyles returns the number of available line dash patterns.

説明

現在設定されている破線の数を返します。

返り値

破線の数

Example:

numLS:=NumDashStyles;

VectorScript Declaration:

PROCEDURE   Opacity

( opacity:INTEGER ) ;

Python:

def  vs.Opacity(opacity):

   return None

Description:

Sets the active opacity.

説明

アクティブな不透明度を設定します。

VectorScript Declaration:

PROCEDURE   OpacityN

(   fillOpacity :INTEGER;     penOpacity :INTEGER ) ;

Python:

def  vs.OpacityN(fillOpacity, penOpacity):

   return None

VectorScript Declaration:

PROCEDURE   PenBack

(   colorR :LONGINT;     colorG :LONGINT;     colorB :LONGINT ) ;

Python:

def  vs.PenBack(color):

   return None

Description:

Procedure PenBack set the active pen background color for the document. RGB values are in the range of 0~65535.

説明

現在設定されている線の地色を変更します。値の範囲は0から65535までです。

Parameters:

color

RGB color value to be set as active pen background.

赤、緑、青の成分

Example:

PenBack(65535,0,39321);

See Also:

RGBToColorIndex   ColorIndexToRGB  

VectorScript Declaration:

PROCEDURE   PenFore

(   colorR :LONGINT;     colorG :LONGINT;     colorB :LONGINT ) ;

Python:

def  vs.PenFore(color):

   return None

Description:

Procedure PenFore sets the active pen foreground color for the document. RGB values are in the range of 0~65535.

説明

現在設定されている線の色を変更します。値の範囲は0から65535までです。

Parameters:

color

RGB color value to be set as active pen foreground.

赤、緑、青の成分

Example:

PenFore(65535,0,39321);

See Also:

RGBToColorIndex   ColorIndexToRGB  

VectorScript Declaration:

PROCEDURE   PenPat

( patNumber:INTEGER ) ;

Python:

def  vs.PenPat(patNumber):

   return None

Special Notes:

PenPat is obsolete as of Vectorworks 2013

Description:

Deprecated - will generate error. Use PenPatN instead.

説明

アクティブな線の模様／種類を設定します。

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

Parameters:

patNumber

Pattern/linestyle ID value.

模様番号

Example:

PenPat(25);
{ uses fill pattern 25 as the active pen pattern }

PenPat(-3);
{ sets a linestyle as the active pen pattern }

See Also:

PenPatN  

VectorScript Declaration:

PROCEDURE   PenPatN

( patNumber:LONGINT ) ;

Python:

def  vs.PenPatN(patNumber):

   return None

Description:

Procedure PenPatN sets the active pen pattern (line style) for the document.

If patNumber is in the range 0 to 71 the linestyle will be set to the corresponding fill pattern. A negative value, will set the linestyle to the line type resource whose index is the negative of the value.

説明

アクティブな線の模様／種類を、0から71または負の値で設定します。

Parameters:

patNumber

Pattern/linestyle ID value.

線の模様／種類番号

Example:

PenPat(25);
{ uses fill pattern 25 as the active pen pattern }

PenPat(-10);
{ sets the line type with the index of 10 as the active pen pattern }

See Also:

FPenPatN  

VectorScript Declaration:

PROCEDURE   PenSize

( lw:INTEGER ) ;

Python:

def  vs.PenSize(lw):

   return None

Description:

Procedure PenSize sets the active line weight for the document.

説明

現在設定されている線の太さを変更します。

Parameters:

lw

Line weight (in mils). Fourteen (14) mils equals one pixel.

線の太さ

Example:

PenSize(28);

VectorScript Declaration:

PROCEDURE   RemoveGradientSegment

(   gradient :HANDLE;     segmentIndex :INTEGER ) ;

Python:

def  vs.RemoveGradientSegment(gradient, segmentIndex):

   return None

Description:

Removes the specified segment from the specified gradient.

説明

グラデーションから変化位置を削除します。

Parameters:

gradient	Gradient from which to remove a segment.	グラデーションのハンドル
segmentIndex	Index of segment to be removed. (segment indexes begin with 1)	変化位置番号（最も左を1とする）

Example:

RemoveGradientSegment (gradientHandle, 4);
{ removes the segment with index 4 }

VectorScript Declaration:

PROCEDURE   SetDashStyle

(   swt :BOOLEAN;     numPairs :INTEGER;     pair1DX :REAL;     pair1DY :REAL;     pair2DX :REAL;     pair2DY :REAL;     pair3DX :REAL;     pair3DY :REAL;     pair4DX :REAL;     pair4DY :REAL;     pair5DX :REAL;     pair5DY :REAL ) ;

Python:

def  vs.SetDashStyle(swt, numPairs, pair1, pair2, pair3, pair4, pair5):

   return None

Description:

Procedure SetDashStyle creates a new linestyle in a Vectorworks document. Parameter swt defines whether the linestyle will be scaled with thickness, and parameter numPairs specifies the number of length pairs defining the linestyle.

The linestyle is defined by up to five black/white length pairs, which are specified in parameters b1,w1 through b5,w5. The minimum length of any given black or white parameter is 1 point, or 1/72 of an inch, and the line specification must be in pairs.

説明

指定された線の長さと間隔をもとに破線の種類を追加します。

破線は５組の黒／白の線分のペアで定義されています。

Example:

SetDashStyle(True,0,1",1/4",1/4",1/4");

VectorScript Declaration:

PROCEDURE   SetDashStyleN

(   name :STRING;     swt :BOOLEAN;     numPairs :INTEGER;     pair1DX :REAL;     pair1DY :REAL;     pair2DX :REAL;     pair2DY :REAL;     pair3DX :REAL;     pair3DY :REAL;     pair4DX :REAL;     pair4DY :REAL;     pair5DX :REAL;     pair5DY :REAL ) ;

Python:

def  vs.SetDashStyleN(name, swt, numPairs, pair1, pair2, pair3, pair4, pair5):

   return None

Description:

Procedure SetDashStyleN creates a new linestyle in a Vectorworks document. Parameter name defines the name of the linestyle, parameter swt defines whether the linestyle will be scaled with thickness, and parameter numPairs specifies the number of length pairs defining the linestyle.

The linestyle is defined by up to five black/white length pairs, which are specified in parameters b1,w1 through b5,w5. The minimum length of any given black or white parameter is 1 point, or 1/72 of an inch, and the line specification must be in pairs.

説明

指定された名前と線の長さと間隔をもとに破線の種類を追加します。

破線は５組の黒／白の線分のペアで定義されています。

Example:

SetDashStyle('My Dash Style', True,0,1",1/4",1/4",1/4");