VectorScript Declaration:

PROCEDURE   BeginContext

;

Python:

def  vs.BeginContext():

   return None

Description:

Use this function in conjuction with EndContext to starts logging changes that are made until the EndContext is reached.

説明

この手続きを実行した後、EndContextを実行するまでの変化を記録します。
EndContextとともに使用します。

See Also:

EndContext  

VectorScript Declaration:

PROCEDURE   BeginMultDashConvert

;

Python:

def  vs.BeginMultDashConvert():

   return None

Description:

Used when a number of pseudo index to dash style conversion operations (or vice versa) are going to be performed.

Use EndMultDashConvert when the conversions are complete.

説明

複数の疑似インデックスから破線の種類への変換操作（またはその逆の操作）を実行するときに使用します。

EndMultDashConvertと共に使用します。

See Also:

GetPseudoIndFromDash   GetDashFromPseudoInd   EndMultDashConvert  

VectorScript Declaration:

FUNCTION   CallToolByIndex

( toolIndex:INTEGER ) :BOOLEAN ;

Python:

def  vs.CallToolByIndex(toolIndex):

   return BOOLEAN

Description:

Similar to CallTool. Takes the internal ID of a tool.

説明

CallToolと同様。ツールの内部IDを引数にとる。

VectorScript Declaration:

FUNCTION   CallToolByName

( toolName:STRING ) :BOOLEAN ;

Python:

def  vs.CallToolByName(toolName):

   return BOOLEAN

Description:

Similar to CallTool, but takes name rather than ID. Supports plug-in tools (but not yet internal tools).

説明

CallToolと同様。IDの代わりに名前を引数にとる。プラグインツールに対応。（内部ツールには未対応）

VectorScript Declaration:

PROCEDURE   CallToolWithMode

(   toolIndex :INTEGER;     modeGroup :LONGINT;     modeButton :LONGINT ) ;

Python:

def  vs.CallToolWithMode(toolIndex, modeGroup, modeButton):

   return None

Description:

Activates the specified Vectorworks tool for a single use with the specified tool mode. After the tool has been used Vectorworks will revert back to the previously active tool.

説明

アクティブツールとそのモードを設定します。終了すると、その前のアクティブツールに戻ります。

Parameters:

toolIndex	Vectorworks tool constant.	ツール番号
modeGroup	Index of the mode group	モードの番号
modeButton	Index of the button in the group.	ボタンの番号

VectorScript Declaration:

PROCEDURE   ClrMessage

;

Python:

def  vs.ClrMessage():

   return None

Description:

Procedure ClrMessage closes the message palette.

説明

メッセージウインドウを消去します。

VectorScript Declaration:

PROCEDURE   ColorIndexToRGB

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

Python:

def  vs.ColorIndexToRGB(color):

   return (red, green, blue)

Description:

Procedure ColorIndexToRGB converts the Vectorworks palette colors from the colors' palette position index to its red, green, and blue component values. RGB values are in the range of 0~65535.

A color table listing with associated index values can be found in the Appendix.

説明

カラーパレットの色番号から各色の成分を取り出します。値の範囲は0から65535までです。

Parameters:

color	Color index.	色番号
red	RGB color component value.	赤の成分
green	RGB color component value.	緑の成分
blue	RGB color component value.	青の成分

Example:

ColorIndexToRGB(45,r,g,b);
{returns the color value components of the color at position 45}

VectorScript Declaration:

PROCEDURE   ColorIndexToRGBN

(   color :INTEGER;   VAR  red :LONGINT;   VAR  green :LONGINT;   VAR  blue :LONGINT;     ignoreBlackBackground :BOOLEAN ) ;

Python:

def  vs.ColorIndexToRGBN(color, ignoreBlackBackground):

   return (red, green, blue)

Description:

Procedure ColorIndexToRGBN converts the Vectorworks palette colors from the colors' palette position index to its red, green, and blue component values. RGB values are in the range of 0~65535.Parameter ignoreBlackBackground specifies whether the black background preference should be ignored. If set to TRUE, black and white indexes will not be inverted in black background.

A color table listing with associated index values can be found in the Appendix.

説明

カラーパレットの色番号から各色の成分を取り出します。値の範囲は0から65535までです。ignoreBlackBackgroundパラメータは背景色を黒にする設定を無視するか否かを設定します。TRUEに設定すると、白と黒のインデックスは背景色が黒であっても逆にされません。

A color table listing with associated index values can be found in the Appendix.

Parameters:

color	Color index	色番号
red	RGB color component value.	赤の成分
green	RGB color component value.	緑の成分
blue	RGB color component value.	青の成分
ignoreBlackBackground	Ignore black background preference setting or not.	背景色を黒にする設定を無視する設定

Example:

ColorIndexToRGBN(257,r,g,b,TRUE);
{returns the color value components of the color index 257 (black)}
{Because ignoreBlackBackground is set to TRUE, the result }
{will always be black RGB color regardless of the black background }{preference setting.}

VectorScript Declaration:

FUNCTION   CreateUUID

:STRING ;

Python:

def  vs.CreateUUID():

   return STRING

Description:

Creates a string representing universe unique identifier. The string is in the form: '{00000000-0000-0000-0000-000000000000}'

説明

Universally Unique Identifierを表す文字列を生成します。文字列は次のような形式である：'{00000000-0000-0000-0000-000000000000}'

VectorScript Declaration:

FUNCTION   Date

(   dateFormat :INTEGER;     infoFormat :INTEGER ) :STRING ;

Python:

def  vs.Date(dateFormat, infoFormat):

   return STRING

Description:

Function Date returns a formatted date and time string.

Table - Values for dateFormat parameter:

Date Format	Constant
Full Date	0
Abbreviated Date	1
Short Date	2

Table - Values for infoFormat parameter:

Date/Time	Constant
Date only	0
Date and Time	1
Time only	2

説明

現在の日付と時間を文字列で返します。

Parameters:

dateFormat	Specify how verbose or compact the resulting string is.	日付の種類
infoFormat	Specify if result should contain date, time or both.	情報の種類

Example:

{ All examples are for the date Friday,  }
{ Nov. 18, 1988 and the time 10:42:24 AM }

Date(0,1);
{returns Friday, November 18, 1988 10:42:24 AM}

Date(0,0);
{returns Friday, November 18, 1988}

Date(2,2);
{returns 10:42:24 AM}

Date(2,1);
{returns 11/18/88 10:42:24 AM}

VectorScript Declaration:

FUNCTION   DelSavedSetting

(   category :STRING;     setting :STRING ) :BOOLEAN ;

Python:

def  vs.DelSavedSetting(category, setting):

   return BOOLEAN

Description:

Delete saved settings.

説明

保存された設定を削除します。

Parameters:

category	The category for the setting.	設定のカテゴリ
setting	The setting to be deleted.	削除する設定

Result:

Return TRUE when successful.

返り値

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

See Also:

DelSavedSettings   SetSavedSetting   GetSavedSetting  

VectorScript Declaration:

FUNCTION   DelSavedSettings

( category:STRING ) :BOOLEAN ;

Python:

def  vs.DelSavedSettings(category):

   return BOOLEAN

Description:

Delete all saved settings in the specified category.

説明

指定したカテゴリの保存された設定を全て削除します。

Parameters:

category

The category to be deleted.

削除の対象となるカテゴリ

Result:

Return TRUE when successful.

返り値

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

See Also:

DelSavedSetting   SetSavedSetting   GetSavedSetting  

VectorScript Declaration:

PROCEDURE   DisableModules

( modules:LONGINT ) ;

Python:

def  vs.DisableModules(modules):

   return None

Description:

Disables modules. The modules parameter is a bitfield indicating which modules to disable.

説明

動作させないモジュールを設定します。モジュールパラメータは、どのモジュールで動作させないかを指定するビットフィールドです。

Parameters:

modules

This modules parameter is a LONGINT value which contains a bit for each possible product module. If a module is enabled, then the corresponding bit is set to 1. If that module is disabled, then its bit is 0. The table below contains selectors that can be used to interpret the results of this function. To determine if a module is enabled, do a bitwise "and" operation with the selector and the value returned by this function. See the usage example below. Table - GetEnabledModules Selectors Module Selector Description Foundation 0   Vectorworks general purpose CAD. RenderWorks 1   Advanced rendering features, lighting, textures. Architect 2 Architectural features including advanced window, door, wall framing, HVAC. Landmark 4 Site modeling and landscape design module. Spotlight 8 Theater lighting, set, and scenic design features. Mechanical 16 Mechanical engineering module for designers and fabricators. Pro 32 Foundation for European market.

モジュール

VectorScript Declaration:

PROCEDURE   DisplayContextHelpOfCurrentPlugin

;

Python:

def  vs.DisplayContextHelpOfCurrentPlugin():

   return None

Description:

This function will display the context help of the plug-in that is considered 'current'. This could be a command plug-in that has a dialog open, or a tool plug-in that is active.

説明

アクティブなプラグインのヘルプをウェブブラウザに表示します。

VectorScript Declaration:

FUNCTION   DisplayContextualHelp

( Identifier:STRING ) :BOOLEAN ;

Python:

def  vs.DisplayContextualHelp(Identifier):

   return BOOLEAN

Description:

Using the identifier string for a GUI element given by the Contextual Help Manager displays the associated contextual help. This could be a WebWorks webpage, a Internet webpage or even a local file.

説明

コンテクストヘルプマネージャから提供されるGUI要素のID文字列を使用して、関連するコンテクストヘルプを表示します。このヘルプには、WebWorksのウェブページ、インターネットのウェブページ、またはローカルファイルを指定できます。

VectorScript Declaration:

PROCEDURE   DisplayOrganizationDialog

( tabToSelect:INTEGER ) ;

Python:

def  vs.DisplayOrganizationDialog(tabToSelect):

   return None

Description:

Displays the organization dialog with the specified integer as the initially slected tab.
0: The most recently displayed tab is selected
1: The Classes tab is selected .
2: The Design Layers tab is selected.
3: The Sheet Layers tab is selected.
4: The Viewports tab is selected.
5: The Saved Views tab is selected.

説明

デフォルトで選択するタブを指定して「階層」ダイアログを表示します。

0：最後に表示されたタブ
1：クラス設定タブ
2：レイヤ設定タブ
3：シートレイヤ設定タブ
4：ビューポート設定タブ
5：登録画面設定タブ

Parameters:

tabToSelect

The tab to be initially selected.

選択するタブの番号

VectorScript Declaration:

FUNCTION   EditCriteriaWithUI

( VAR criteria:DYNARRAY[] of CHAR ) :INTEGER ;

Python:

def  vs.EditCriteriaWithUI(criteria):

   return (INTEGER, criteria)

Description:

Edit a criteria string with Edit Criteria Dialog.

説明

条件編集ダイアログで検索条件を編集します。

Parameters:

criteria

Pass in a criteria to be edited, and output the modified criteria if the function result is TRUE.

編集される検索条件を渡すと、結果がTRUEの場合は、変更された検索条件が返されます。

Result:

The funtion returns the following values:
0 - failed. The input criteria is incorrect.
1 - The edit was OK
2 - The edit was Cancel

返り値

次の値を返します:
0 - 失敗。検索条件が不正
1 - 編集がOK
2 - 編集がキャンセル

VectorScript Declaration:

PROCEDURE   EndContext

( acceptOrReject:INTEGER ) ;

Python:

def  vs.EndContext(acceptOrReject):

   return None

Description:

Use this function in conjuction with BeginContext to have VW automatically accept or reject any changes that were made during the Begin/End block.

説明

Begin/Endブロックの間に、自動的になされたどんな変更にも対応する／しないを設定します。BeginContextとともに使用します。

Parameters:

acceptOrReject

Specify 0 to reject changes or 1 to accept changes

1：対応する／0：しない

See Also:

BeginContext  

VectorScript Declaration:

PROCEDURE   EndMultDashConvert

;

Python:

def  vs.EndMultDashConvert():

   return None

Description:

Used in conjunction with BeginMultDashConvert to end the set of conversions.

説明

BeginMultDashConvertと共に使用して、破線の複数変換操作を終了します。

See Also:

GetPseudoIndFromDash   GetDashFromPseudoInd   BeginMultDashConvert  

VectorScript Declaration:

FUNCTION   ExportImageFile

(   hHmage :HANDLE;     filePath :DYNARRAY[] of CHAR ) :BOOLEAN ;

Python:

def  vs.ExportImageFile(hHmage, filePath):

   return BOOLEAN

Description:

Export the specified Image object in Vectorworks as an image file.

説明

指定したイメージ図形をイメージファイルとして取り出します。

Parameters:

hHmage	The handle of the image object to be exported.	イメージ図形のハンドル
filePath	Full path to the output image file.	イメージファイル取り出し先のフルパス

VectorScript Declaration:

FUNCTION   FndError

:BOOLEAN ;

Python:

def  vs.FndError():

   return BOOLEAN

Description:

Function FndError returns whether an error has occurred within a VectorScript subroutine. Provided as a debugging tool, FndError receives notification after execution of every line of code whether an error has occurred.

説明

直前で実行したプログラムにエラーが発生した場合はTRUEを返します。

VectorScript Declaration:

PROCEDURE   ForEachObjectAtPoint

(   actionFunc :PROCEDURE;     objOptions :INTEGER;     travOptions :INTEGER;     locX :REAL;     locY :REAL;     pickRadius :REAL ) ;

Python:

def  vs.ForEachObjectAtPoint(actionFunc, objOptions, travOptions, loc, pickRadius):

   return None

Description:

Performs an action for each object at the specified point in the drawing. This call was implemented to get past the practical limitations of PickObject, which only finds the topmost object. This call will find all of the objects at a given point.

"actionFunc" should actually be a function, not a procedure as the declaration indicates.

If the callback function returns FALSE, ForEachObjectAtPoint will not process any more objects at the specified point.

Table - ForEachObjectAtPoint Selectors

Object Options
Option	Selector	Description
All objects	0
Visible Objects only	1
Selected Objects only	2
Unlocked objects only	4
Traversal Options
Option	Selector	Description
Traverse Shallow	0
Traverse Groups	1	Traverse inside groups

説明

指定した座標の下にある、条件に合致した図形を、指定した手続きで処理します。

Example:

PROCEDURE Example;
VAR
   gx1, gy1 : REAL;

FUNCTION DoIt(h1 :HANDLE) :BOOLEAN;
BEGIN
   DSelectAll;
   SetSelect(h1);
   Redraw;
   Wait(1);
END;

BEGIN
   GetPt(gx1, gy1);
   ForEachObjectAtPoint(DoIt, 0, 0, gx1, gy1, 5);
END;
RUN(Example);

See Also:

PickObject   GetPickObjectInfo  

VectorScript Declaration:

PROCEDURE   ForEachObjectInLayer

(   actionFunc :PROCEDURE;     objOptions :INTEGER;     travOptions :INTEGER;     layerOptions :INTEGER ) ;

Python:

def  vs.ForEachObjectInLayer(actionFunc, objOptions, travOptions, layerOptions):

   return None

Description:

Traverses through all objects according to specified search options and applies the specified action to each object. The 'actionFunc' procedure should return false to continue with next object, or return true to stop the traversal.

Table - ForEachObjectInLayer Selectors

Object Options
Option	Selector	Description
All objects	0
Visible Objects only	1
Selected Objects only	2
Unlocked objects only	4
Traversal Options
Option	Selector	Description
Traverse Shallow	0
Traverse Groups	1	Traverse inside groups
Traverse Deep	2	Traverse all containers (walls, extrudes, sweeps, etc)
Layer Options
Option	Selector	Description
Current layer	0
All layers	1
Visible layers	2
Editable layers	4
Snappable layers	8

説明

指定した条件に合致した図形を、指定した手続きで処理します。

Parameters:

actionFunc	Subroutine which performs operation on found objects.	関数型サブルーチンの名前
objOptions	Object selection option index.	図形選択オプション番号
travOptions	Search options index.	検索オプション番号
layerOptions	Layer selection option index.	レイヤ選択オプション番号

Example:

PROCEDURE Example;

FUNCTION MakeItRed(h :HANDLE) :BOOLEAN;
VAR
	r, g, b :LONGINT;
BEGIN
	ColorIndexToRGB(7, r, g, b);
	SetFillBack(h, r, g, b);
END;
	
BEGIN
	ForEachObjectInLayer(MakeItRed, 2, 0, 4);
END;
RUN(Example);

VectorScript Declaration:

PROCEDURE   ForEachObjectInList

(   actionFunc :PROCEDURE;     objOptions :INTEGER;     travOptions :INTEGER;     list :HANDLE ) ;

Python:

def  vs.ForEachObjectInList(actionFunc, objOptions, travOptions, list):

   return None

Description:

Processes all items in the specified list and and applies the specified action to each item.

Table - ForEachObjectInList Selectors

Object Options
Option	Selector	Description
All objects	0
Visible Objects only	1
Selected Objects only	2
Locked objects only	4
Traversal Options
Option	Selector	Description
Traverse Shallow	0
Traverse Groups	1	Traverse inside groups
Traverse Deep	2	Traverse all containers (walls, extrudes, sweeps, etc)

説明

指定した条件に合致した図形を、指定した手続きで処理します。

Parameters:

actionFunc	Subroutine which performs operation on found objects.	手続き型サブルーチンの名前
objOptions	Object selection option index.	図形選択オプション番号
travOptions	Search options index.	検索オプション番号
list	Handle to first item in list.	ハンドル

Example:

PROCEDURE Example;
CONST
   pioName = 'Complex Window 2';
   parameter = 'MeasureHeight';
   value = 'Head of Window';
   
FUNCTION DoIt(h :HANDLE) :BOOLEAN;
BEGIN
   h := FInSymDef(h);
   SetRField(h, pioName, parameter, value);
END;

BEGIN
    ForEachObjectInList(DoIt, 0, 0, FSymDef);
END;
RUN(Example);

VectorScript Declaration:

FUNCTION   GetActiveSerialNumber

:STRING ;

Python:

def  vs.GetActiveSerialNumber():

   return STRING

Description:

Gets the currently active serial number.

説明

アクティブなシリアル番号を返します。

VectorScript Declaration:

PROCEDURE   GetArrayDimensions

(   arrayname :ARRAY;   VAR  rowStart :INTEGER;   VAR  rowEnd :INTEGER;   VAR  columnStart :INTEGER;   VAR  columnEnd :INTEGER ) ;

Python:

def  vs.GetArrayDimensions(arrayname):

   return (rowStart, rowEnd, columnStart, columnEnd)

Description:

Returns the dimensions of the specified array.

説明

指定した配列の大きさを返します。

Parameters:

arrayname	Name of array.	配列
rowStart	Start row value.	行の開始番号
rowEnd	End row value.	行の終了番号
columnStart	Start column value.	列の開始番号
columnEnd	End column value.	列の終了番号

VectorScript Declaration:

FUNCTION   GetCallBackInval

:BOOLEAN ;

Python:

def  vs.GetCallBackInval():

   return BOOLEAN

Description:

Returns whether callbacks are invalidating portions of the screen that are being changed.

説明

コールバック関数による画面の更新を無効にしているかどうかを返します。

VectorScript Declaration:

PROCEDURE   GetClosestPt

( VAR  obj :HANDLE;     ptX :REAL;     ptY :REAL;   VAR  index :INTEGER;   VAR  containedObj :LONGINT ) ;

Python:

def  vs.GetClosestPt(obj, pt):

   return (obj, index, containedObj)

Description:

Returns the index number of the object closest to the specified location.

The index value will return 0 if no vertex can be determined as closest, and will return -1 if the object does not support GetClosestPt.

For container objects, GetClosestPt has distinct behaviors. For walls, if the closest vertex is
is in a subobject, obj will be set to a handle to the subobject. For symbols and plug-in objects, an index to the sub-object will be returned via parameter containedObj.

GetClosestPt supports only 2D objects.

説明

ハンドルで指定した図形の頂点を返します。頂点が見つからない場合は、0を返します。

Parameters:

obj	Handle to object.	図形のハンドル
pt	Coordinate location of comparison point.	頂点のX座標
index	Index to vertex.	頂点のY座標
containedObj	Index of sub-object.	頂点番号

Example:

PROCEDURE GetClosestPtExample;
VAR
	obj :HANDLE; 
	ptX, ptY :REAL; 
	index :INTEGER; 
	containedObj :LONGINT;
BEGIN
	GetPt(ptX, ptY);
	obj := PickObject(ptX, ptY);
	GetClosestPt(obj, ptX, ptY, index, containedObj);
	SetPenFore(obj, 65535, 0, 0);
END;
RUN(GetClosestPtExample);

VectorScript Declaration:

PROCEDURE   GetClosestSide

(   obj :HANDLE;     ptX :REAL;     ptY :REAL;   VAR  index1 :INTEGER;   VAR  index2 :INTEGER ) ;

Python:

def  vs.GetClosestSide(obj, pt):

   return (index1, index2)

Description:

Returns the indices of the vertices that define the side closest to the specified location.

GetClosestSide supports only 2D objects. If the object is unsupported, -1 will be returned as the index values.

説明

ハンドルで指定した2次元図形で、指定した座標に最も近い頂点の番号を返します。

Parameters:

obj	Handle to object.	図形のハンドル
pt	Coordinates of location.	指定する座標
index1	Index of first vertex of closest side.	頂点番号1
index2	Index of second vertex of closest side.	頂点番号2

VectorScript Declaration:

PROCEDURE   GetCurrentLocalization

( VAR  language :STRING;   VAR  subLanguage :STRING ) ;

Python:

def  vs.GetCurrentLocalization():

   return (language, subLanguage)

Description:

Get the Vectorworks language in the ISO 639-3 draft standard Language ID and sublanguage is unused and will be the empty string reserved for future use for a regional dialect.

Currently this will always return the same language for a given installation of Vectorworks.

説明

Vectorworksの言語環境をISO 639-3 ドラフト形式の言語IDで返します。sublanguageは現在使われていません。

Parameters:

language	Output parameter. Returns language in ISO 639-3 draft standard Language ID.	言語環境番号
subLanguage	Output parameter. Unused. Returns empty string.	未使用

VectorScript Declaration:

FUNCTION   GetCurrentMode

:INTEGER ;

Python:

def  vs.GetCurrentMode():

   return INTEGER

Description:

Returns the current application protection mode.

Return values:
0 - Mode Not Set
1 - Full Mode
2 - Demo Mode
4 - Education Mode
8 - Student Mode
16 - Viewer Mode
32 - Unlicensed Mode
64 - Banner Mode
128 - Watermark New Files Mode
256 - Print Watermark Mode
512 - Save Educational File Format Mode
1024 - Open Educational File Format Mode
2048 - Vector Script Export Mode
4096 - Beta Serial Number Mode

説明

アプリケーションの現在のプロテクトモードを返します。

Example:

Procedure TestMode;

Var
vwMode : LongInt;
ModeCheck : Boolean;


FUNCTION BitCheck(largeNum, smallNum :LONGINT) :BOOLEAN;
{Returns true if smallNum is a power of 2 present in largeNum.}

VAR
bit :INTEGER;
BEGIN
BitCheck := FALSE;
bit := 15;
while bit > -1 do BEGIN
if largeNum >= (2 ^ bit) then BEGIN
largeNum := largeNum - (2 ^ bit);
IF (2 ^ bit) = smallNum THEN BEGIN
BitCheck := TRUE;
bit := 0;
END;
END;
bit := bit - 1;
END;
END;

Begin
vwMode := GetCurrentMode;
{Educational or Student version}
ModeCheck := (BitCheck(vwMode, 4)) | (BitCheck(vwMode, 8));

AlrtDialog(Concat(vwMode,':',ModeCheck));
End;

Run (TestMode)

VectorScript Declaration:

FUNCTION   GetDashFromPseudoInd

(   pseudoIndex :INTEGER;   VAR  outDashStyle :LONGINT ) :BOOLEAN ;

Python:

def  vs.GetDashFromPseudoInd(pseudoIndex):

   return (BOOLEAN, outDashStyle)

Description:

Gets the dash style that corresponds to the pseudo index and returns the style's internal index. Returns TRUE if successful.

説明

疑似インデックスと合致する破線の種類を検索し、その内部インデックス番号を返します。成功すると、TRUEを返します。

Parameters:

pseudoIndex	Pseudo index (negative value) for which a dash style is requested.	疑似インデックス
outDashStyle	Negative internal index of a dashed line type corresponding to the pseudo index.	破線の種類のインデックス(負の値)

See Also:

GetPseudoIndFromDash   BeginMultDashConvert   EndMultDashConvert  

VectorScript Declaration:

FUNCTION   GetEnabledModules

:LONGINT ;

Python:

def  vs.GetEnabledModules():

   return LONGINT

Description:

Determines which combination of product modules are currently enabled.

This function returns a LONGINT value which contains a bit for each possible product module. If a module is enabled, then the corresponding bit will be set to 1. If that module is disabled, then its bit will be 0. The table below contains selectors that can be used to interpret the results of this function. To determine if a module is enabled, do a bitwise "and" operation with the selector and the value returned by this function. See the usage example below.

Table - GetEnabledModules Selectors

Module	Selector	Description
Foundation	0	Vectorworks general purpose CAD.
RenderWorks	1	Advanced rendering features, lighting, textures.
Architect	2	Architectural features including advanced window, door, wall framing, HVAC.
Landmark	4	Site modeling and landscape design module.
Spotlight	8	Theater lighting, set, and scenic design features.
Mechanical	16	Mechanical engineering module for designers and fabricators.
Pro	32	Foundation for European market.

説明

現在利用可能なプロダクトモジュールの組み合わせを返します。

この関数は利用可能なプロダクトモジュールのビットを含んだLONGINT値を返します。モジュールが利用可能な場合は、相当するビットを1に設定されます。モジュールが利用不可能な場合は、相当するビットを0に設定されます。上記の表はこの関数の結果を解釈するために使用するセレクタです。モジュールが利用可能かを調べるために、セレクタと返された値とでAND計算をします。下記の使用例をご参照ください。

Result:

A LONGINT bitfield value with a bit for each possible product module.

返り値

利用可能なプロダクトモジュールのビットを含んだLONGINT値を返します。

Example:

PROCEDURE testModules;

{----------------------------------------------------------}
FUNCTION bittest(value, mask :LONGINT) :BOOLEAN; 
VAR 
	bit :INTEGER; 
BEGIN 
	bittest := FALSE; 
	bit := 31;    { 2 ^ 31 is high order bit of a LONGINT argument. }
	WHILE ((bit > -1) & (bittest = false)) DO BEGIN 
		IF value >= (2 ^ bit) THEN BEGIN 
			value := value - (2 ^ bit); 
			IF (2 ^ bit) = mask THEN bittest := TRUE; 
		END; 
		bit := bit - 1; 
	END; 
END; 


{----------------------------------------------------------}
FUNCTION IsModuleEnabled(whichModule :LONGINT) :BOOLEAN; 
VAR 
	enabledModules :LONGINT; 
BEGIN 
	enabledModules := GetEnabledModules; 
	IsModuleEnabled := bittest(enabledModules, whichModule)
END; 


BEGIN
	IF IsModuleEnabled(4) & IsModuleEnabled(1)  THEN BEGIN
		{ Landmark and Renderworks are both enabled. } 
		{ ... }
	END;
END;
RUN(testModules);

See Also:

DisableModules  

VectorScript Declaration:

PROCEDURE   GetMainDisplayBounds

( VAR  outTop :INTEGER;   VAR  outLeft :INTEGER;   VAR  outBottom :INTEGER;   VAR  outRight :INTEGER ) ;

Python:

def  vs.GetMainDisplayBounds():

   return (outTop, outLeft, outBottom, outRight)

Description:

Returns the bounds of the main display device (Macintosh Only).

説明

主画面の境界を返します（Macntoshのみ）

VectorScript Declaration:

FUNCTION   GetNetAdapterInfo

(   adapterIndex :INTEGER;   VAR  outMacAddr :STRING ) :BOOLEAN ;

Python:

def  vs.GetNetAdapterInfo(adapterIndex):

   return (BOOLEAN, outMacAddr)

Description:

Return information about the network adapter

説明

ネットワークアダプターの情報を取得します。

VectorScript Declaration:

PROCEDURE   GetOSVersion

( VAR  major :LONGINT;   VAR  minor :LONGINT;   VAR  incr :LONGINT ) ;

Python:

def  vs.GetOSVersion():

   return (major, minor, incr)

Description:

Returns the version of the current operating system.

説明

動作しているOSのバージョンを返します。

Parameters:

major	Major revision number	メジャー
minor	Minor revision number	マイナー
incr	Increment revision number	増値

Example:

PROCEDURE ShowVersionInfo;
VAR
	osMajor, osMinor, osIncr :LONGINT;
	vwMajor, vwMinor, vwMaint, platform: INTEGER;
	str :STRING;
BEGIN
	str := '';
	GetOSVersion(osMajor, osMinor, osIncr);
	GetVersion(vwMajor, vwMinor, vwMaint, platform);
	If platform = 1 then BEGIN
		str := Concat(str, 'Platform: Macintosh', chr(13));
		IF osMajor = 0 THEN osMajor := 10;
		str := Concat(str, 'OS Version: ', osMajor, '.', osMinor, '.', osIncr, chr(13));
	end else if platform = 2 then BEGIN
		str := Concat(str, 'Platform: Windows', chr(13));
		IF (osMajor = 4) & (osMinor = 10) THEN str := Concat(str, 'OS Version: 98 SE', chr(13)) ELSE 
		IF (osMajor = 5) & (osMinor =  1) THEN str := Concat(str, 'OS Version: XP',    chr(13)) ELSE 
		str := Concat(str, 'OS Version: ', osMajor, '.', osMinor, '.', osIncr, chr(13));
	END;
	str := Concat(str, 'VW Version: ', vwMajor, '.', vwMinor, '.', vwMaint);
	AlrtDialog(str);
END;
RUN(ShowVersionInfo);

VectorScript Declaration:

FUNCTION   GetPaletteVisibility

( paletteName:STRING ) :BOOLEAN ;

Python:

def  vs.GetPaletteVisibility(paletteName):

   return BOOLEAN

Description:

Gets the visibility state of a palette.

説明

パレットの表示／非表示を返します。

Parameters:

paletteName

Name of the palette

パレットの名前

Result:

Returns true if the palette is visible, false otherwise.

返り値

TRUE：パレットは表示されています。
FALSE：パレットは表示されてません。

See Also:

SetPaletteVisibility  

VectorScript Declaration:

FUNCTION   GetPickObjectInfo

(   pX :REAL;     pY :REAL;   VAR  h :HANDLE;   VAR  subH :HANDLE;   VAR  message :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetPickObjectInfo(p):

   return (BOOLEAN, h, subH, message)

Description:

Function GetPickObjectInfo returns a handle to an object found at a user selected point.

Parameter subH returns a handle to a sub-selectable object (e.g., a symbol in a wall) if such an object exists. Parameter message is currently unused, and always returns 0.

説明

指定した座標の下にある図形のハンドルを返します。座標の下にある図形が、他の図形を内包されている場合（壁に挿入されたシンボルなど）は、内包されている図形のハンドルも返します。

Parameters:

p	Coordinate location to test for object.	座標
h	Returns handle to object.	図形のハンドル
subH	Returns handle to sub selectable object.	内包されている図形のハンドル
message	Resereved for future use. Specify a dummy INTEGER variable.	不使用（常に０が返る）

Example:

WHILE NOT GetPickObjectInfo(pX,pY,hObject,hSymbol,dummyVar) DO BEGIN
    GetPt(pX,pY);
END;

See Also:

PickObject   ForEachObjectAtPoint  

VectorScript Declaration:

FUNCTION   GetPlantToolInitialized

:BOOLEAN ;

Python:

def  vs.GetPlantToolInitialized():

   return BOOLEAN

Description:

Returns whether or not the plant tool has been initialized or not.

説明

「植栽シンボル配置」ツールが初期化されているかどうかを返します。

VectorScript Declaration:

FUNCTION   GetPlantToolPlacementMode

:INTEGER ;

Python:

def  vs.GetPlantToolPlacementMode():

   return INTEGER

Description:

This returns the current placement mode stored in the plant tool

説明

「植栽シンボル配置」ツールで設定されている配置モードを返します。

VectorScript Declaration:

FUNCTION   GetPlantToolPlantName

:STRING ;

Python:

def  vs.GetPlantToolPlantName():

   return STRING

Description:

Returns the name of the current plant that is stored in the plant tool.

説明

「植栽シンボル配置の設定」ダイアログで設定した植栽名を返します。

VectorScript Declaration:

FUNCTION   GetPlantToolSpacing

:REAL ;

Python:

def  vs.GetPlantToolSpacing():

   return REAL

Description:

This returns the spacing that is currently stored in the plant tool.

説明

「植栽シンボル配置の設定」ダイアログで設定した間隔を返します。

VectorScript Declaration:

PROCEDURE   GetProduct

( VAR  product :INTEGER;   VAR  modules :LONGINT ) ;

Python:

def  vs.GetProduct():

   return (product, modules)

Description:

Identifies what NNA products and product packages are available in the current product installation.

Obsolete as of 10. Use GetEnabledModules instead.

説明

製品番号とパッケージ番号を返します。
使用できなくなった関数／手続きです。代わりにGetEnabledModulesを使用してください。

Parameters:

product	Product index.	製品番号
modules	Package index.	パッケージ番号

See Also:

GetEnabledModules  

VectorScript Declaration:

FUNCTION   GetPseudoIndFromDash

(   dashStyle :LONGINT;   VAR  outPseudoIndex :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetPseudoIndFromDash(dashStyle):

   return (BOOLEAN, outPseudoIndex)

Description:

Supplies a pseudo index for a dashed style. The returned index is not guaranteed to produce the same line type from file to file, nor even in the same file if line types change.
Returns TRUE if successful.

説明

破線の種類の疑似インデックスを返します。返り値のインデックスは、タイプが変更されると、ファイル間や同じファイル場でも同じ破線の種類を作成するとは限りません。
成功すると、TRUEを返します。

Parameters:

dashStyle	Negative internal index of a dashed line type.	破線の種類
outPseudoIndex	Pseudo index (a negative number) corresponding to the dash style. The pseudo index is not guaranteed to produce the same line across files (or even in the same file if line types are changed).	擬似インデックス(負の値)

See Also:

GetDashFrompseudoInd   BeginMultDashConvert   EndMultDashConvert  

VectorScript Declaration:

FUNCTION   GetSavedSetting

(   category :STRING;     setting :STRING;   VAR  value :STRING ) :BOOLEAN ;

Python:

def  vs.GetSavedSetting(category, setting):

   return (BOOLEAN, value)

Description:

Reads a value from the saved settnigs file. This can be used to remember various user settings between running sessions of Vectorworks. For example, a script may want to remember a dialog's position or a font settings. The saved settings should not be used for critical information, but rather for convenience settings.

If the settings file is lost or damaged the script should revert to a reasonable default value, and typically this would not warrant an alert dialog.

説明

設定ファイル（SavedSettings.xml）から値を読み込みます。
設定ファイルはVectorWorks使用中に行った様々なユーザ設定を記憶するために使用します。
スクリプトでダイアログ位置、フォント設定などを記憶する場合に利用できます。

Result:

Returns true is the requested setting is found and read from the saved settings file, false otherwise.

返り値

TRUE : 読み込み成功

VectorScript Declaration:

PROCEDURE   GetScreen

( VAR  x1 :INTEGER;   VAR  y1 :INTEGER;   VAR  x2 :INTEGER;   VAR  y2 :INTEGER ) ;

Python:

def  vs.GetScreen():

   return (x1, y1, x2, y2)

Description:

Procedure GetScreen returns the top-left and bottom-right corners of the display screen. These values will change as different sized screens are used. This procedure can be utilized to aid in development of dialog boxes, or as a check of screen size for sizing or displaying custom dialogs.

説明

モニタ画面の左上と右下の座標を返します。

Parameters:

x1	Returns X coordinate of top left of screen.	画面の左上のX座標
y1	Returns Y coordinate of top left of screen.	画面の左上のY座標
x2	Returns X coordinate of bottom right of screen.	画面の右下のX座標
y2	Returns Y coordinate of bottom right of screen.	画面の右下のY座標

Example:

PROCEDURE Example;
VAR 
	x1, y1, x2, y2 :INTEGER;
BEGIN
	GetScreen(x1, y1, x2, y2);
	Message(x1,' ',y1,' ',x2,' ',y2);
END;
RUN(Example);

VectorScript Declaration:

FUNCTION   GetTickCount

:LONGINT ;

Python:

def  vs.GetTickCount():

   return LONGINT

Description:

Returns number of ticks (1/60th second) since system startup.

説明

システムの時間を返します。

返り値

システムの時間（Tick=60分の1秒）

Example:

PROCEDURE Example;
VAR
	tick1, tick2 :LONGINT;
BEGIN
	tick1 := GetTickCount;
	ForEachObject(ResetObject, (T=86));
	tick2 := GetTickCount;
	Message('Seconds elapsed equals: ', (tick2 - tick1) / 60);
END;
Run(Example);

VectorScript Declaration:

PROCEDURE   GetVersion

( VAR  major :INTEGER;   VAR  minor :INTEGER;   VAR  maintenance :INTEGER;   VAR  platform :INTEGER ) ;

Python:

def  vs.GetVersion():

   return (major, minor, maintenance, platform)

Description:

Returns version information about the Vectorworks application. Parameter major returns the major version number of the application. Parameters minor and maintenance return minor version information. Parameter platform returns the OS platform on which Vectorworks is running (1 = Macintosh, 2 = Windows).

Vectorworks 2008 has version major number 13, 2009 - 14 and so on.

For example:

Vectorworks 8.0.1 running on a Macintosh would return:

major: 8
minor: 0
maintenance: 1
platform: 1

説明

VectorWorksのバージョンとOSの種類を返します。

Parameters:

major	Returns major version number of application.	バージョンの整数部
minor	Returns minor version number of application.	バージョンの小数部
maintenance	Returns maintenance version number of application.	OSの種類
platform	Returns platform of application.	1 : Macintosh / 2 : Windows

Example:

PROCEDURE Example;
VAR 
	osMajor, osMinor, osIncr :LONGINT; 
	appMajor, appMinor, appMaint, platform :INTEGER;
	platformStr :STRING;
BEGIN
	GetVersion(appMajor, appMinor, appMaint, platform);
	GetOSVersion(osMajor, osMinor, osIncr);
	IF (platform = 1) 
		THEN platformStr := 'MacOS'
		ELSE platformStr := 'Windows';
	Message('Vectorworks ', appMajor, '.', appMinor, '.', appMaint, ' running on ', platformStr, ' ', osMajor, '.', osMinor, '.', osIncr);
END;
RUN(Example);

VectorScript Declaration:

PROCEDURE   GetVersionEx

( VAR  major :INTEGER;   VAR  minor :INTEGER;   VAR  maintenance :INTEGER;   VAR  platform :INTEGER;   VAR  buildNum :LONGINT ) ;

Python:

def  vs.GetVersionEx():

   return (major, minor, maintenance, platform, buildNum)

Description:

Returns version information about the Vectorworks application. Parameter major returns the major version number of the application. Parameters minor and maintenance return minor version information. Parameter platform returns the OS platform on which Vectorworks is running (1 = Macintosh, 2 = Windows).
Parameter buildNum returns the build number of the version.

Vectorworks 2008 has version major number 13, 2009 - 14 and so on.

For example:

Vectorworks 2010.0.1 running on a Macintosh would return:

major: 15
minor: 0
maintenance: 1
platform: 1
buildNum: 95668

説明

VectorWorksのバージョンとビルド番号とOSの種類を返します。

Parameters:

major	Returns major version number of application.	メジャー
minor	Returns minor version number of application.	マイナー
maintenance	Returns maintenance version number of application.	増値
platform	Returns platform of application.	OSの種類
buildNum	Returns the build number of application.	ビルド番号

Example:

PROCEDURE Example;
VAR 
	osMajor, osMinor, osIncr, buildNum :LONGINT; 
	appMajor, appMinor, appMaint, platform :INTEGER;
	platformStr :STRING;
BEGIN
	GetVersionEx(appMajor, appMinor, appMaint, platform, buildNum);
	GetOSVersion(osMajor, osMinor, osIncr);
	IF (platform = 1) 
		THEN platformStr := 'MacOS'
		ELSE platformStr := 'Windows';
	Message('Vectorworks ', appMajor, '.', appMinor, '.', appMaint, ' build ', buildNum, ' running on ', platformStr, ' ', osMajor, '.', osMinor, '.', osIncr);
END;
RUN(Example);

VectorScript Declaration:

PROCEDURE   GetWorkingPlane

( VAR  x :REAL;   VAR  y :REAL;   VAR  z :REAL;   VAR  xRotation :REAL;   VAR  yRotation :REAL;   VAR  zRotation :REAL ) ;

Python:

def  vs.GetWorkingPlane():

   return (x, y, z, xRotation, yRotation, zRotation)

Description:

Retrieves the location and orientation of the working plane.

説明

ワーキングプレーンの位置と方向を返します。

Parameters:

x	X-coordinate of the working plane	X座標
y	Y-coordinate of the working plane	Y座標
z	Z-coordinate of the working plane	Z座標
xRotation	X-coordinate value of the rotation	X軸方向の回転角度
yRotation	Y-coordinate value of the rotation	Y軸方向の回転角度
zRotation	Z-coordinate value of the rotation	Z軸方向の回転角度

See Also:

SetWorkingPlane  

VectorScript Declaration:

PROCEDURE   GetWorkingPlaneMat

(   refID :LONGINT;   VAR  outCenterPtX :REAL;   VAR  outCenterPtY :REAL;   VAR  outCenterPtZ :REAL;   VAR  outNormalX :REAL;   VAR  outNormalY :REAL;   VAR  outNormalZ :REAL;   VAR  outUVecX :REAL;   VAR  outUVecY :REAL;   VAR  outUVecZ :REAL ) ;

Python:

def  vs.GetWorkingPlaneMat(refID):

   return (outCenterPt, outNormal, outUVec)

Description:

Get the specified working plane matrix.

説明

指定したワーキングプレーンマトリックスを取得します。

Parameters:

refID	Reference ID of the working plane.	ワーキングプレーンの参照ID
outCenterPt	Output. The working plane center.	出力。ワーキングプレーン中心
outNormal	Output. The working plane normal.	出力。ワーキングプレーン法線
outUVec	Output. The U Vector of the plane.	出力。面のUベクトル。

VectorScript Declaration:

PROCEDURE   GetWorkingPlaneN

( VAR  outCenterPtX :REAL;   VAR  outCenterPtY :REAL;   VAR  outCenterPtZ :REAL;   VAR  outNormalX :REAL;   VAR  outNormalY :REAL;   VAR  outNormalZ :REAL;   VAR  outUVecX :REAL;   VAR  outUVecY :REAL;   VAR  outUVecZ :REAL ) ;

Python:

def  vs.GetWorkingPlaneN():

   return (outCenterPt, outNormal, outUVec)

Description:

Get the active working plane.

説明

アクティブなワーキングプレーンを取得します。

Parameters:

outCenterPt	Output. The working plane center.	出力。ワーキングプレーン中心
outNormal	Output. The working plane normal.	出力。ワーキングプレーン法線
outUVec	Output. The U Vector of the plane.	出力。面のUベクトル。

VectorScript Declaration:

FUNCTION   ImportImageFile

(   filePath :DYNARRAY[] of CHAR;     importPtX :REAL;     importPtY :REAL ) :HANDLE ;

Python:

def  vs.ImportImageFile(filePath, importPt):

   return HANDLE

Description:

Import the specified image file as an Image object in Vectorworks.

説明

指定したイメージファイルをVectorworksのイメージ図形として取り込みます。

Parameters:

filePath	Full path to the image file.	イメージファイルのフルパス
importPt	Location on which the file should be imported.	ファイルが取り込まれる位置

VectorScript Declaration:

FUNCTION   ImportImageFileN

(   filePath :DYNARRAY[] of CHAR;     importPtX :REAL;     importPtY :REAL;     mode :INTEGER ) :HANDLE ;

Python:

def  vs.ImportImageFileN(filePath, importPt, mode):

   return HANDLE

Description:

Import the specified image file as an Image object in Vectorworks. This function allow controlling the options when importing the image.

説明

指定したイメージファイルをVectorworksのイメージ図形として取り込みます。取り込み時にオプションを設定できます。

Parameters:

filePath	Import file path.	イメージファイルのパス
importPt	The import location.	イメージが取り込まれる位置
mode	Import mode: 0 - import using import option dialog; 1 - import using the last options. If the call was never made with option dialog, then the first time it will show the options dialog.	取り込みモード： 0 - 取り込み時にオプション設定ダイアログをひらく 1 - 最後に使用したオプション設定で取り込みを実行する。オプションが未設定の場合、取り込み時にダイアログをひらく

Result:

Return the imported image handle, or NIL if the import failed.

返り値

イメージ図形のハンドルを返します。 取り込みに失敗した場合はNILを返します。

See Also:

ImportImageFile  

VectorScript Declaration:

PROCEDURE   InstallScriptAddPath

( fullPath:DYNARRAY[] of CHAR ) ;

Python:

def  vs.InstallScriptAddPath(fullPath):

   return None

Description:

This function can only be used doring Partner Product install script to add files, by full path, to the install memento for automatic deletion during uninstall.

説明

「パートナー製品」のインストールスクリプト中でのみ使用できます。アンインストール時の自動削除用にフルパスでファイルをインストール記録に追加します。

VectorScript Declaration:

FUNCTION   IsCoPlanar

(   refID1 :LONGINT;     refID2 :LONGINT ) :BOOLEAN ;

Python:

def  vs.IsCoPlanar(refID1, refID2):

   return BOOLEAN

Description:

Returns true if two planes are coplanar.

説明

2つの平面が同一平面の場合、TRUEを返します。

Parameters:

refID1	Reference ID of the first plane.	一つ目の面の参照ID
refID2	Reference ID of the second plane.	二つ目の面の参照ID

VectorScript Declaration:

FUNCTION   IsPerpPlane

(   refID1 :LONGINT;     refID2 :LONGINT ) :BOOLEAN ;

Python:

def  vs.IsPerpPlane(refID1, refID2):

   return BOOLEAN

Description:

Returns true if two planes are perpendicular.

説明

2つの平面が直交している場合、TRUEを返します。

Parameters:

refID1	Reference ID of the first plane.	一つ目の面の参照ID
refID2	Reference ID of the second plane.	二つ目の面の参照ID

VectorScript Declaration:

PROCEDURE   LandmarkMatchSlope

(   h :HANDLE;     h3d :HANDLE;     landmarkObj :HANDLE ) ;

Python:

def  vs.LandmarkMatchSlope(h, h3d, landmarkObj):

   return None

Description:

Matches slope and contour angle information of a Landmark object to the specified 3D polygon.

説明

傾斜と造成図形の勾配基準線の角度を、3D多角形に合わせます。

VectorScript Declaration:

PROCEDURE   Message

(   z :ANY ) ;

Python:

def  vs.Message(z):

   return None

Description:

Procedure Message displays a floating message palette onscreen. Parameters z1 thru zN specify the values to be displayed in the palette. Parameters can be any supported data type or variables.

If Message is called and the palette is already displayed, the value in the palette will be replaced by the new information.

説明

メッセージウインドウに文字列を表示します。

Example:

Message('Hello, world');

Message('The Number of objects was :',theNumber);
{displays a string using the variable value}

VectorScript Declaration:

PROCEDURE   NameUndoEvent

( eventName:STRING ) ;

Python:

def  vs.NameUndoEvent(eventName):

   return None

Description:

Procedure NameUndoEvent names the undo event that is currently being built by VectorScript execution. Parameter eventName is the name of the undo event.

説明

スクリプトの実行開始から構築された取り消し（undo）イベントに名前をつけます。引数eventNameが取り消しイベントの名前となります。

Parameters:

eventName

Name of undo event.

イベントの名前

VectorScript Declaration:

FUNCTION   ObjPropsEditDlg

( hObj:HANDLE ) :BOOLEAN ;

Python:

def  vs.ObjPropsEditDlg(hObj):

   return BOOLEAN

Description:

Show object properties edit dialog.

説明

オブジェクトのプロパティを編集するダイアログを表示します。

Parameters:

hObj

The object which properties will be edited.

オブジェクトのハンドル

Result:

Return TRUE if the edit was successful.

返り値

正常に編集できた場合にTrueを返します。

VectorScript Declaration:

PROCEDURE   OpenScriptResPal

(   paletteName :STRING;     open :BOOLEAN ) ;

Python:

def  vs.OpenScriptResPal(paletteName, open):

   return None

Description:

Open or close a script resource palette.

説明

スクリプトリソースパレットを開く、あるいは閉じます。

Parameters:

paletteName	The script resource palette.	スクリプトリソースパレット
open	Pass in TRUE for the palette to be opened.	パレットを開くにはTRUEを渡します。

See Also:

CreateScriptResource   GetScriptResource   SetScriptResource  

VectorScript Declaration:

FUNCTION   OpenURL

( URLname:DYNARRAY[] of CHAR ) :BOOLEAN ;

Python:

def  vs.OpenURL(URLname):

   return BOOLEAN

Description:

Opens a web page or file using the default browser or appropriate application (e.g. Adobe Acrobat). Returns a boolean indicating the success of the operation.

The URL (Uniform Resource Locator) is a pointer to a resource on the World Wide Web. It specifies both the protocol and location of the document to open. For files on the local computer, the URL should begin with file:// protocol specifier. For web pages, the URL should begin with http://. The URL should use forward slashes / to separate parts of the path.

There are some platform differences to be aware of. Windows will accept either \ or / as the path separators. MacOS X requires that file:// URLs begin with /Volumes/ before the drive name. Also, currently the MacOS X implementation of OpenURL does not accept spaces in the URL. Spaces should be replaced with the escape code %20 before calling this function.

Note: The function GetFolderPath returns a string with separators specific for the platform it is running on (: on Mac and \ on Windows). If your script calls this function to assemble a local file:// URL then you will have to replace the : separators with / characters.

説明

デフォルトブラウザやAdobe Acrobatを使ってURLを開きます。URLが開けた場合はTRUEを返します。

Parameters:

URLname

The Uniform Resource Locator for the web page or file to open.

URL

Example:

{ Open a webpage. }
	status := OpenURL('http://www.vectorworks.net');

	{ Open an HTML file on MacOS X. }
	status := OpenURL('file:///Volumes/MyMacXHD/Documents/My%20Files/Test.html');
	
	{ Open a PDF file in Acrobat on MacOS X. }
	status := OpenURL('file:///Volumes/MyMacXHD/Documents/My%20Files/VSLG11.pdf');

	{ Open a PDF file in Acrobat on MacOS 9. }
	status := OpenURL('file:///MyMac9HD/My Files/VSLG11.pdf');
	
	{ Open a PDF file in Acrobat on Windows. }
	status := OpenURL('file:///C:/My Files/VSLG11.pdf';
	

VectorScript Declaration:

FUNCTION   PickObject

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

Python:

def  vs.PickObject(p):

   return HANDLE

Description:

Function PickObject returns a handle to an object in the document. The function receives a coordinate location, specified by parameter p, and checks this location for the presence of an object. If an object exists at the location, the function returns a handle to the object.

説明

指定した座標の下にある図形のうち、最上位の図形のハンドルを返します。

Parameters:

p

Coordinate location to test for object.

座標

返り値

図形のハンドル

Example:

FUNCTION UserObjectPick :HANDLE;
VAR 
	x, y :REAL;
BEGIN
	GetPt(x, y);
	UserObjectPick := PickObject(x, y);
END;

See Also:

GetPickObjectInfo   ForEachObjectAtPoint  

VectorScript Declaration:

FUNCTION   PlanarPtTo3DModelPt

(   refID :LONGINT;     pt2DX :REAL;     pt2DY :REAL;   VAR  outPt3DX :REAL;   VAR  outPt3DY :REAL;   VAR  outPt3DZ :REAL ) :BOOLEAN ;

Python:

def  vs.PlanarPtTo3DModelPt(refID, pt2D):

   return (BOOLEAN, outPt3D)

Description:

Transform a 2D point on the specified plane into a 3D point.

説明

指定した平面の2D座標を3D座標に変換します。

Parameters:

refID	Reference ID of the plane.	面の参照ID
pt2D	The 2D point on the specified plane.	指定の面上の2D座標
outPt3D	Output. The resulted 3D point.	出力。結果の3D座標

VectorScript Declaration:

FUNCTION   PlanarPtToScreenPlanePt

(   refID :LONGINT;     pt2DX :REAL;     pt2DY :REAL;   VAR  outPtX :REAL;   VAR  outPtY :REAL ) :BOOLEAN ;

Python:

def  vs.PlanarPtToScreenPlanePt(refID, pt2D):

   return (BOOLEAN, outPt)

Description:

Projects a 2D point from the specified plane onto the screen plane.

説明

特定の平面上の2D座標をスクリーンプレーンに投影します。

Parameters:

refID	Reference ID of the plane.	面の参照ID
pt2D	Input the 2D point on the plane.	指定の面上の2D座標
outPt	Output the 2D point on the screen.	出力。スクリーンプレーン上の2D座標

VectorScript Declaration:

PROCEDURE   PrepRelatedObjectForChange

( objectAboutToBeChange:HANDLE ) ;

Python:

def  vs.PrepRelatedObjectForChange(objectAboutToBeChange):

   return None

Description:

Prepares some other related object for a change thats about to occur.

説明

行われようとしている変更に関連した図形を準備します。

Parameters:

objectAboutToBeChange

The object to be prepared for a change

図形のハンドル

VectorScript Declaration:

PROCEDURE   ProgressDlgClose

;

Python:

def  vs.ProgressDlgClose():

   return None

Description:

Close the progress dialog opened with ProgressDlgOpen.

説明

進行状況ダイアログを閉じます。

VectorScript Declaration:

PROCEDURE   ProgressDlgEnd

;

Python:

def  vs.ProgressDlgEnd():

   return None

Description:

End a progress context started with ProgressDlgStart. This will make the progress jump to the percentage declared when started.

説明

進行度の増加を終了します。 開始時に設定した増加率だけ進行状況が推移します。

VectorScript Declaration:

FUNCTION   ProgressDlgHasCancel

:BOOLEAN ;

Python:

def  vs.ProgressDlgHasCancel():

   return BOOLEAN

Description:

Determine if the dialog has been canceled. The dialog must have cancelation enabled when created.

説明

ダイアログがキャンセルされたかどうかを返します。 ダイアログ作成時にキャンセルボタンが有効になっている必要があります。

VectorScript Declaration:

PROCEDURE   ProgressDlgOpen

(   title :STRING;     canCancel :BOOLEAN ) ;

Python:

def  vs.ProgressDlgOpen(title, canCancel):

   return None

Description:

Show a progress dialog that doesn't interrupt the script. ProgressDlgClose must be used to close the dialog.

説明

スクリプトの進行状況を表示するダイアログを開きます。 ダイアログを閉じるには、 ProgressDlgClose を使用します。

VectorScript Declaration:

PROCEDURE   ProgressDlgOpenDelay

(   title :STRING;     canCancel :BOOLEAN;     delaySec :INTEGER ) ;

Python:

def  vs.ProgressDlgOpenDelay(title, canCancel, delaySec):

   return None

Description:

Show a progress dialog that doesn't interrupt the script. The dialog will be displaed after specified dealy time (in miliseconds). ProgressDlgClose must be used to close the dialog.

説明

スクリプトの進行状況を表示するダイアログを開きます。 指定した時間(ミリ秒)が経過してからダイアログが表示されます。 ダイアログを閉じるには、 ProgressDlgClose を使用します。

VectorScript Declaration:

PROCEDURE   ProgressDlgSetBotMsg

( message:STRING ) ;

Python:

def  vs.ProgressDlgSetBotMsg(message):

   return None

Description:

Set bottom message of a progress dialog.

説明

進行状況ダイアログの下部のメッセージを設定します。

VectorScript Declaration:

PROCEDURE   ProgressDlgSetMeter

( message:STRING ) ;

Python:

def  vs.ProgressDlgSetMeter(message):

   return None

Description:

Set progress meter message of a progress dialog.

説明

進行状況ダイアログのメーター部分のメッセージを設定します。

VectorScript Declaration:

PROCEDURE   ProgressDlgSetTopMsg

( message:STRING ) ;

Python:

def  vs.ProgressDlgSetTopMsg(message):

   return None

Description:

Set top message of a progress dialog.

説明

進行状況ダイアログの上部のメッセージを設定します。

VectorScript Declaration:

PROCEDURE   ProgressDlgStart

(   Percentage :REAL;     LoopCount :LONGINT ) ;

Python:

def  vs.ProgressDlgStart(Percentage, LoopCount):

   return None

Description:

Start a progress context. This defines progress percentage and loop count for ProgressDlgYield calls. LoopCount is fit in the Percentage of the progress

説明

進行度の増加を開始します。 ProgressDlgYeld 呼び出し時に指定するループカウントを定義します。ループカウントにインデックスと増加率を設定します。

VectorScript Declaration:

PROCEDURE   ProgressDlgYield

( count:LONGINT ) ;

Python:

def  vs.ProgressDlgYield(count):

   return None

Description:

Increases the progress. This must be called between ProgressDlgStart and ProgressDlgEnd and defines the LoopCount index.

説明

インデックスで指定したループカントにより進行度を増加させます。 ProgressDlgStart と ProgressDlgEnd の間で呼ばれます。

VectorScript Declaration:

PROCEDURE   PythonBeginContext

;

Python:

def  vs.PythonBeginContext():

   return None

Description:

This function creates a context in which PythonExecute scripts are run.

This function consecutive python scripts to be executed inside the same python environment.

説明

この関数はPythonExecuteスクリプトが実行されるコンテキストを作成します。

あとに実行されるPythonスクリプトが同じPython環境で実行されるようにします。.

See Also:

PythonExecute   PythonEndContext  

VectorScript Declaration:

PROCEDURE   PythonEndContext

;

Python:

def  vs.PythonEndContext():

   return None

Description:

Closes python context previously opened with PythonBeginContext.

説明

PythonBeginContextで開いたPythonコンテキストを閉じます。

See Also:

PythonBeginContext  

VectorScript Declaration:

PROCEDURE   PythonExecute

( script:DYNARRAY[] of CHAR ) ;

Python:

def  vs.PythonExecute(script):

   return None

Description:

Execute the given python script.

You can use 'include' in python to run additional code in python files. However, before you execute the script make sure the python file are foundable through the PythonGetSearchPath. Use PythonSetSearchPath to change it.

Scripts executed via this function should not contain User Interactive functions like GetPt for example.

説明

与えられたPythonスクリプトを実行します。

Pythonで'include'を用いて追加のコードを実行できます。スクリプトを実行する前に、PythonGetSearchPathでPythonファイルが探せることを確認しておくこと。PythonSetSearchPathで変更できる。

例えばGetPtのように、この関数で実行するスクリプトにはユーザー操作を伴う関数を使ってはいけません。

Parameters:

script

The script to be executed.

実行するスクリプト

See Also:

PythonGetSearchPath   PythonSetSearchPath  

VectorScript Declaration:

FUNCTION   PythonGetSearchPath

:DYNARRAY[] of CHAR ;

Python:

def  vs.PythonGetSearchPath():

   return DYNARRAY of CHAR

Description:

Return the search path for python files.

説明

Pythonファイルの検索パスを返します。

Result:

The result is a string of semicolon delimited paths. The path it similar to the 'Open' function path parameter.

返り値

複数のパスをセミコロンで区切って返します。Open関数の引数のパスと同様のパスです。

See Also:

PythonSetSearchPath   PythonExecute  

VectorScript Declaration:

PROCEDURE   PythonSetSearchPath

( pathList:DYNARRAY[] of CHAR ) ;

Python:

def  vs.PythonSetSearchPath(pathList):

   return None

Description:

Set the search path for python files.

説明

Pythonファイルの検索パスを設定します。

Parameters:

pathList

A string of semicolon delimited paths. The path it similar to the 'Open' function path parameter.

複数のパスをセミコロンで区切った文字列を渡します。Open関数の引数のパスと同様のパスです。

See Also:

PythonGetSearchPath   PythonExecute  

VectorScript Declaration:

PROCEDURE   ReDraw

;

Python:

def  vs.ReDraw():

   return None

Description:

Procedure ReDraw invokes a screen redraw of newly created objects in the active Vectorworks document. If new objects are to be manipulated using procedures which operate on selected objects, a call to ReDraw should precede the selected object routines to ensure that all new objects are correctly identified.

説明

直前に作成または変更された図形を再描画します。

VectorScript Declaration:

PROCEDURE   ReDrawAll

;

Python:

def  vs.ReDrawAll():

   return None

Description:

Procedure ReDrawAll invokes a full screen redraw of the active Vectorworks document. ReDrawAll is used when the document view needs to be refreshed prior to additional operation being performed in the document.

説明

すべての図形を再描画します。

VectorScript Declaration:

PROCEDURE   RedrawSelection

;

Python:

def  vs.RedrawSelection():

   return None

Description:

This will update selection indication without redrawing the drawing.

説明

選択されている図形を再描画します。

VectorScript Declaration:

PROCEDURE   ResetObject

( objectHandle:HANDLE ) ;

Python:

def  vs.ResetObject(objectHandle):

   return None

Description:

Update the specified object using the current settings and parameter values. This will reset the bounding box of the object. If the object is in a wall, then the wall is reset also.

An object of any type may be passed to this function to have its boundary reset. The following object types will be reset in a way that is appropriate for each type: Plug-in Object, Symbol Definition, Wall, Roof Container, Bitmap, Picture, Dimension, Extrude, Multiple Extrude, Sweep, Polygon, Polyline, Worksheet.

説明

現在の設定やパラメータの値を使って指定した図形を更新します。図形のバウンドボックスをリセットします。壁の中の図形であれば、壁もリセットします。

以下の図形タイプはそれぞれのタイプに適当なバウンドボックスにリセットされます。
プラグインオブジェクト、シンボル、壁、屋根、ビットマップ、絵、寸法、柱状体、多段柱状体、スイープ、多角形、曲線、ワークシート

Parameters:

objectHandle

Handle to the object to be reset.

図形のハンドル

VectorScript Declaration:

PROCEDURE   RGBToColorIndex

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

Python:

def  vs.RGBToColorIndex(red, green, blue):

   return color

Description:

Procedure RGBToColorIndex converts the Vectorworks palette colors from its' red, green, and blue component values to the colors' palette position index. Parameters red, green, and blue return the color components of the swatch, and parameter color is the palette position ID of the color swatch. RGB values are in the range of 0~65535.

A color table listing with associated index values can be found in the Appendix.

説明

各色の成分に一番近いカラーパレットの色番号を返します。値の範囲は0から65535までです。

Parameters:

red	RGB color component value.	赤の成分
green	RGB color component value.	緑の成分
blue	RGB color component value.	青の成分
color	Color index.	色番号

Example:

PROCEDURE Example;
VAR
	red, green, blue :LONGINT;
	colorIndex :INTEGER;
BEGIN
	GetPenFore(FSActLayer, red, green, blue);
	RGBToColorIndex(red, green, blue, colorIndex);
	Message(colorIndex);
END;
RUN(Example);