VectorScript Declaration:

FUNCTION   ActLayer

:HANDLE ;

Python:

def  vs.ActLayer():

   return HANDLE

Description:

Function ActLayer returns a handle to the currently active layer in a document.

説明

アクティブなレイヤのハンドルを返します。

See Also:

ActiveClass   ActSymDef   GetLName  

VectorScript Declaration:

FUNCTION   AddLevelFromTemplate

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

Python:

def  vs.AddLevelFromTemplate(storyHandle, index):

   return BOOLEAN

Description:

Adds a new Story Layer to the Story pointed to by 'storyHandle', using the Story Level Template at 'index' as a template. The story must not already contain a Story Level with the same level type or elevation as the template. If the template has a layer name set, a new layer will be created and associated with the new Story Level.

説明

ストーリレベルテンプレートを使用して、指定したストーリにストーリレベルを追加します。 テンプレートのレベルタイプおよび高さの設定がストーリ内の既存のものと重複していない必要があります。 テンプレートにレイヤー名が設定されている場合、新しいレイヤーが作成され、ストーリーレベルに関連付けられます。

Parameters:

storyHandle	The handle of the Story to add the new Story Level to.	ストーリのハンドル
index	The index of the Story Level Template to use when creating the Story Level.	ストーリレベルテンプレートのインデックス

Result:

Whether the Story Level was successfully created.

返り値

ストーリレベルが正しく追加されたかどうかを返します。

Example:

VAR

storyHandle : HANDLE
success:BOOLEAN

BEGIN

storyHandle := CreateStory('Floor 1', '-1');
success := AddLevelFromTemplate(storyHandle,1);

See Also:

CreateStory   AddStoryLevel   RemoveStoryLevel   SetLevelElevation   GetLevelElevation  

VectorScript Declaration:

FUNCTION   AddStoryLevel

(   storyHandle :HANDLE;     levelType :STRING;     elevation :REAL;     layerName :STRING ) :BOOLEAN ;

Python:

def  vs.AddStoryLevel(storyHandle, levelType, elevation, layerName):

   return BOOLEAN

Description:

Adds a new Story Layer to the Story pointed to by 'storyHandle'. There must not be another story level in this story that matches 'levelType' or 'elevation', or the function will fail. If the layer 'layerName' already exists, it will be associated with the new Story Level.

説明

指定したストーリにストーリレベルを追加します。 レベルタイプおよび高さの設定がストーリ内の既存のものと重複していない必要があります。 レイヤー名を指定した場合、ストーリーレベルに関連付けられます。

Parameters:

storyHandle	The handle of the story that the new level should be added to.	ストーリのハンドル
levelType	The level type of the new Story Level. This cannot be blank.	ストーリレベルタイプの名前
elevation	The elevation of the new Story Level in the story.	ストーリレベルの高さ
layerName	The name of the layer to associate with the new Story Level. This is optional.	ストーリレベルに関連付けるレイヤの名前

Result:

Whether the new Story Level was created and added.

返り値

ストーリレベルが作成され、追加されたかどうかを返します。

Example:

VAR

storyHandle : HANDLE
success:BOOLEAN

BEGIN

storyHandle := CreateStory('Floor 1', '-1');
success := AddStoryLevel(storyHandle, 'Finish Floor', 0, 'Floor');

See Also:

CreateStory   AddLevelFromTemplate   RemoveStoryLevel   SetLevelElevation   GetLevelElevation  

VectorScript Declaration:

FUNCTION   AddStoryLevelN

(   storyHandle :HANDLE;     levelType :STRING;     elevation :REAL;     layerName :STRING ) :BOOLEAN ;

Python:

def  vs.AddStoryLevelN(storyHandle, levelType, elevation, layerName):

   return BOOLEAN

Description:

Adds a new Story Layer to the Story pointed to by 'storyHandle'. There must not be another story level in this story that matches 'levelType' or 'elevation', or the function will fail. If the layer 'layerName' already exists, it will be associated with the new Story Level.

説明

ハンドルで指定したストーリにストーリレベルを追加します。 レベルタイプおよび高さの設定がストーリ内の既存のものと重複していない必要があります。 既存のレイヤー名を指定した場合、新しいストーリーレベルに関連付けられます。

Parameters:

storyHandle	The handle of the story that the new level should be added to.	ストーリのハンドル
levelType	The level type of the new Story Level. This cannot be blank.	ストーリレベルタイプの名前（空白不可）
elevation	The elevation of the new Story Level in the story. The elevation is in document units.	ストーリレベルの高さ（ファイルの単位）
layerName	The name of the layer to associate with the new Story Level. This is optional.	ストーリレベルに関連付けるレイヤの名前

Result:

Whether the new Story Level was created and added.

返り値

新しいストーリレベルが作成され追加されたかどうかを返します。

Example:

VAR

storyHandle : HANDLE
success:BOOLEAN

BEGIN

storyHandle := CreateStory('Floor 1', '-1');
success := AddStoryLevelN(storyHandle, 'Finish Floor', 0, 'Floor');

See Also:

CreateStory   AddLevelFromTemplate   RemoveStoryLevel   SetLevelElevationN   GetLevelElevationN  

VectorScript Declaration:

FUNCTION   AssociateLayerWithStory

(   layer :HANDLE;     story :HANDLE ) :BOOLEAN ;

Python:

def  vs.AssociateLayerWithStory(layer, story):

   return BOOLEAN

Description:

Associates a Layer with a Story. When a Layer is associated with a Story, the Layer's elevation is displayed relative to the Story elevation. If the elevation of the associated Story is changed, the elevation of the Layer changes with it.

説明

レイヤとストーリを関連付けます。レイヤがストーリに関連付けられている場合、レイヤの高さはストーリの高さからの相対的な高さになります。関連付けられたストーリの高さが変更された場合、レイヤの高さも連動して変更されます。

Parameters:

layer	The Layer to associate.	関連付けるレイヤ
story	The Story to associate.	関連付けるストーリ

Result:

Whether the Layer was successfully associated with the Story. This will fail if there is already another Layer associated with the Story that has the same Layer Level Type as the Layer passed in.

返り値

レイヤがストーリと関連付けられたかどうかを返します。ストーリに同じレイヤレベルタイプのレイヤが関連付けられている場合は新たに関連付ける事は出来ません。

Example:

VAR

success:BOOLEAN;
story:HANDLE;
layer:HANDLE;

BEGIN

story := GetObject('4th Floor');
layer := GetObject('Plan 4');
success := AssociateLayerWithStory(layer, story);

See Also:

GetNumStories   GetStoryOfLayer   CreateStory  

VectorScript Declaration:

PROCEDURE   CopyMode

( mode:INTEGER ) ;

Python:

def  vs.CopyMode(mode):

   return None

Description:

Procedure CopyMode sets the transfer mode for the active design layer. If a sheet layer is active, the procedure has no effect.

Transfer Modes

Transfer Mode	Index Value
Copy	8
OR	9
XOR	10
BIC	11
Inverse Copy	12
Inverse OR	13
Inverse XOR	14
Inverse BIC	15

The design layer will only be imaged with the transfer mode on systems which support it, like Windows. Setting the transfer mode to a mode other than Copy (i.e. 8, Paint mode), when the current layer transparency percentage is 0, will also automatically change the layer transparency percentage to 50. Similarly, setting the transfer mode to Copy, when the current layer transparency percentage is greater than 0, will also automatically change the layer transparency percentage to 0. This is to approximately preserve the appearance of the layer on systems that don't support transfer modes, like Quartz on the Mac.

説明

アクティブなレイヤの表示モードを設定します。

Parameters:

mode

Mode index value.

表示モード

See Also:

SetLayerTransparency  

VectorScript Declaration:

FUNCTION   CreateLayer

(   layerName :STRING;     layerType :INTEGER ) :HANDLE ;

Python:

def  vs.CreateLayer(layerName, layerType):

   return HANDLE

Description:

Creates a layer of the specified type.

layerType values:
Design = 1
Presentation = 2

説明

指定した種類のレイヤを作成します。
レイヤの種類（１：デザインレイヤ／２：シートレイヤ）

VectorScript Declaration:

FUNCTION   CreateLayerLevelType

( name:STRING ) :BOOLEAN ;

Python:

def  vs.CreateLayerLevelType(name):

   return BOOLEAN

Description:

Creates a Layer Level Type. A Layer can be assigned a Layer Level Type, which defines its location within a Story.

説明

レイヤのレベルタイプを作成します。

Parameters:

name

The name of the Layer Level Type to create.

作成されるレイヤレベルタイプの名前

Result:

Whether a Layer Level Type was successfully created.

返り値

レイヤのレベルタイプが作成出来たかどうかが返ってきます。

See Also:

GetNumLayerLevelTypes   GetLayerLevelType   SetLayerLevelType  

VectorScript Declaration:

FUNCTION   CreateLevelTemplate

(   layerName :STRING;     scaleFactor :REAL;     levelType :STRING;     elevation :REAL;     wallHeight :REAL;   VAR  index :INTEGER ) :BOOLEAN ;

Python:

def  vs.CreateLevelTemplate(layerName, scaleFactor, levelType, elevation, wallHeight):

   return (BOOLEAN, index)

Description:

Creates a Story Level Template in the current file. Sets the index parameter to the index of the new template in the list of templates. Story Levels contain a level type, elevation, and optional layer to be used to bound objects on stories; Story Level Templates define a generic level that can be added to multiple stories.

説明

アクティブなファイルに新しいストーリレベルテンプレートを作成します。 作成したストーリレベルテンプレートはテンプレート一覧に追加されインデックスが設定されます。 ストーリーレベルにはレベルタイプ、高さ、関連付けるレイヤが含まれています。 ストーリレベルテンプレートは複数のストーリに追加できる一般的なレベルを定義します。

Parameters:

layerName	The layer name for the new Story Level Template. This can be blank, meaning that layers will not be created for instances of the new Story Level Template.	レイヤの名前 空白にするとレイヤを作成しないように設定できます。
scaleFactor	The scale factor for the (optional) layer associated with this Story Level Template.	レイヤの縮尺
levelType	The level type for the new Story Level Template. There may be multiple Story Level Templates with the same level type, as long as they have different elevations.	レベルタイプの名前 レベルタイプの名前は重複可能
elevation	The elevation of the Story Level Template, relative to the height of the story in which the level is used.	ストーリレベルの高さ
wallHeight	The wall height for (optional) layers created when using this Story Level Template in a Story. If the layer name is empty, this parameter is unused.	レイヤの壁の高さ レイヤの名前が空白の場合無効
index	After the function is called, this parameter contains the index of the new Story Level Template.	ストーリレベルテンプレートのインデックス

Result:

Whether the Story Level Template was successfully created.

返り値

ストーリレベルテンプレートが正しく作成されたかどうかを返します。

Example:

VAR

success:BOOLEAN;
index:INTEGER;

BEGIN

success := CreateLevelTemplate('Mod-Slab', 1, 'LT_Slab', 0, 6, index);

See Also:

GetNumLevelTemplates   GetLevelTemplateName   SetLevelTemplateName   DeleteLevelTemplate   GetLevelTemplateInfo  

VectorScript Declaration:

FUNCTION   CreateLevelTemplateN

(   layerName :STRING;     scaleFactor :REAL;     levelType :STRING;     elevation :REAL;     wallHeight :REAL;   VAR  index :INTEGER ) :BOOLEAN ;

Python:

def  vs.CreateLevelTemplateN(layerName, scaleFactor, levelType, elevation, wallHeight):

   return (BOOLEAN, index)

Description:

Creates a Story Level Template in the current file. Sets the index parameter to the index of the new template in the list of templates. Story Levels contain a level type, elevation, and optional layer to be used to bound objects on stories; Story Level Templates define a generic level that can be added to multiple stories.

説明

アクティブなファイルに新しいストーリレベルテンプレートを作成します。 作成したストーリレベルテンプレートはテンプレート一覧に追加されインデックスが設定されます。 ストーリーレベルにはレベルタイプ、高さ、関連付けるレイヤが含まれています。 ストーリレベルテンプレートは複数のストーリに追加できる一般的なレベルを定義します。

Parameters:

layerName	The layer name for the new Story Level Template. This can be blank, meaning that layers will not be created for instances of the new Story Level Template.	レイヤの名前 空白にするとレイヤを作成しないように設定できます。
scaleFactor	The scale factor for the (optional) layer associated with this Story Level Template.	ストーリレベルテンプレートに関連づけられたレイヤの縮尺
levelType	The level type for the new Story Level Template. There may be multiple Story Level Templates with the same level type, as long as they have different elevations.	ストーリレベルテンプレートのレベルタイプ 異なる高さの場合、同じレベルタイプ名で複数のストーリレベルテンプレートを設定できます。
elevation	The elevation of the Story Level Template, relative to the height of the story in which the level is used. The elevation is in document units.	ストーリレベルテンプレートの高さ ストーリからの相対高さで、ファイルの単位で指定します。
wallHeight	The wall height for (optional) layers created when using this Story Level Template in a Story. The wall height is in document units. If the layer name is empty, this parameter is unused.	ストーリレベルテンプレートから作成されるレイヤの壁の高さ 壁の高さはファイルの単位で、レイヤの名前が空白の場合は使用されません。
index	After the function is called, this parameter contains the index of the new Story Level Template.	関数が使用された後、ストーリレベルテンプレートのインデックスが戻ります。

Result:

Whether the Story Level Template was successfully created.

返り値

ストーリレベルテンプレートが正しく作成されたかどうかを返します。

Example:

VAR

success:BOOLEAN;
index:INTEGER;

BEGIN

success := CreateLevelTemplateN('Mod-Slab', 1, 'LT_Slab', 0, 6, index);

See Also:

GetNumLevelTemplates   GetLevelTemplateName   SetLevelTemplateName   DeleteLevelTemplate  

VectorScript Declaration:

FUNCTION   CreateStory

(   name :STRING;     suffix :STRING ) :BOOLEAN ;

Python:

def  vs.CreateStory(name, suffix):

   return BOOLEAN

Description:

Creates a Story. Stories are used to group layers and are shown on the Story pane of the Organization dialog.

説明

ストーリを作成します。

Parameters:

name	The name of the Story to create.	作成するストーリの名前
suffix	The suffix to be used at the end of the name of a Layer assoiciated with the Story.	ストーリに関係付けられるレイヤの名前の後記号

Result:

Whether the Story was successfully created.

返り値

ストーリが作成されたかどうかが返ります。

Example:

VAR

success:BOOLEAN

BEGIN

success := CreateStory('4th Floor', '4');

See Also:

GetNumStories   GetStoryOfLayer   AssociateLayerWithStory  

VectorScript Declaration:

FUNCTION   CreateStoryLayerTemplate

(   name :STRING;     scaleFactor :REAL;     layerLevelType :STRING;     elevationOffset :REAL;     defaultWallHeight :REAL;   VAR  index :INTEGER ) :BOOLEAN ;

Python:

def  vs.CreateStoryLayerTemplate(name, scaleFactor, layerLevelType, elevationOffset, defaultWallHeight):

   return (BOOLEAN, index)

Description:

Creates a Story Layer Template in the current file. Sets the index parameter to the index of the new template in the list of templates. Story Layer Templates are used to define what Layers are typically found in a Story. When a Story is created, the user has the option to automatically create the Layers defined by the Story Layer Templates.

説明

現在のファイルにストーリレイヤテンプレートを作成します。

Parameters:

name	The name of the Story Layer Template.	ストーリレイヤテンプレートの名前
scaleFactor	The scale to be assinged to any Layers created from this template.	このテンプレートによって作られるレイヤの縮尺
layerLevelType	The Layer Level Type to be assigned to any Layers created from this template.	このテンプレートによって作られるレイヤのレイヤレベルタイプ
elevationOffset	The offset of the elevation of any Layer created from this template from the elevation of its Story.	このテンプレートによって作られるレイヤの高さオフセット
defaultWallHeight	The wall height to be assigned to any Layer created from this template.	このテンプレートによって作られるレイヤの初期設定の壁高さ
index	The index of the new template in the list of templates.	作成されたテンプレートの番号

Result:

Whether a Story Layer Template is successfully created.

返り値

ストーリレイヤテンプレートが作成出来たかどうかが返ってきます。

Example:

VAR

success:BOOLEAN;

BEGIN

success := CreateStoryLayerTemplate('Mod-Slab', 1, 'LT_Slab', 0, 6);

See Also:

GetNumStoryLayerTemplates   GetStoryLayerTemplateName   DeleteStoryLayerTemplate  

VectorScript Declaration:

FUNCTION   DeleteLevelTemplate

( index:INTEGER ) :BOOLEAN ;

Python:

def  vs.DeleteLevelTemplate(index):

   return BOOLEAN

Description:

Deletes the nth Story Level Template from the current file. For example, if 3 is passed in, it will delete the 3rd Story Level Template in the file.

説明

アクティブなファイルから指定したインデックスのストーリレベルテンプレートを削除します。

Parameters:

index

The index of the Story Level Template to be deleted.

ストーリーレベルテンプレートのインデックス

Result:

Whether the Story Level Template at 'index' was found and deleted successfully.

返り値

ストーリレベルテンプレートが正しく削除されたかどうかを返します。

Example:

VAR

success:BOOLEAN;

BEGIN

success := DeleteStoryTemplate(3);

See Also:

GetNumStoryLayerTemplates   GetLevelTemplateName   SetLevelTemplateName   CreateLevelTemplate   GetLevelTemplateInfo  

VectorScript Declaration:

FUNCTION   DeleteStoryLayerTemplate

( index:INTEGER ) :BOOLEAN ;

Python:

def  vs.DeleteStoryLayerTemplate(index):

   return BOOLEAN

Description:

Deletes the nth Story Layer Template from the current file. For example, if 3 is passed in, it will delete the 3rd Story Layer Template in the file.

説明

現在のファイルからn番目のストーリレイヤテンプレートを削除します。

Parameters:

index

Index of the Story Layer Template to delete.

削除するストーリレイヤテンプレートのインデックス番号

Result:

Whether a Story Layer Template with the indicated index existed in the file.

返り値

指定されたレイヤテンプレートがファイルに存在したかどうかを返します

Example:

VAR

success:BOOLEAN;

BEGIN

success := DeleteStoryTemplate(3);

See Also:

GetNumStoryLayerTemplates   GetStoryLayerTemplateName   CreateStoryLayerTemplate  

VectorScript Declaration:

PROCEDURE   DisplayLayerScaleDialog

;

Python:

def  vs.DisplayLayerScaleDialog():

   return None

Description:

Brings up the Layer Scale dialog.

説明

縮尺ダイアログを表示します。

VectorScript Declaration:

FUNCTION   FLayer

:HANDLE ;

Python:

def  vs.FLayer():

   return HANDLE

Description:

Function FLayer returns a handle to the first layer in a Vectorworks document.

説明

最上位のレイヤのハンドルを返します。

VectorScript Declaration:

PROCEDURE   GetDrawingArea

( VAR  outDrawingArea :STRING;   VAR  outIsOther :BOOLEAN;   VAR  outIsOnePrintedPage :BOOLEAN ) ;

Python:

def  vs.GetDrawingArea():

   return (STRING, outDrawingArea, outIsOther, outIsOnePrintedPage)

Description:

Gets the drawing area of the active layer, as in Page Setup dialog. If Other is selected returns an empty string as outDrawingArea and true for outIsOther.If One Printer Page is Selected, returns empty string for outDrawingArea and true for outIsOnePrinterPage. Otherwise, returns the drawing area name (ISO A3, US ARCH A, etc.)

説明

用紙設定ダイアログボックスの図面領域を取得します。

Parameters:

outDrawingArea	Returns the paper size name of the active layer, if it is found in the predefined paper sizes from DwgSizes-Universal.txt.	アクティブレイヤの用紙サイズ名を返します。
outIsOther	Returns true, if the paper size of the active layer is not one of the predefined sizes from DwgSizes-Universal.txt.	用紙サイズが設定ファイルで定義されたサイズのいずれでもない(「その他」を選択など)の場合TRUEを返します。
outIsOnePrintedPage	Returns true, if One Printer Page was selected in Page Setup dialog and the page area is the same as the selected from the printer page area.	用紙サイズがプリンター設定の用紙サイズと同じ場合にTRUEを返します。

VectorScript Declaration:

FUNCTION   GetLayer

( h:HANDLE ) :HANDLE ;

Python:

def  vs.GetLayer(h):

   return HANDLE

Description:

Function GetLayer returns a handle to the layer of the referenced object.

説明

ハンドルで指定した図形が存在するレイヤのハンドルを返します。

Parameters:

h

Handle to object.

図形のハンドル

Example:

LayerHandle:=GetLayer(ObjHd);

VectorScript Declaration:

FUNCTION   GetLayerByName

( layerName:STRING ) :HANDLE ;

Python:

def  vs.GetLayerByName(layerName):

   return HANDLE

Description:

Returns a handle to the specified layer.

説明

指定した名前をもつレイヤのハンドルを返します。

Parameters:

layerName

Name of layer.

レイヤの名前

Result:

Returns a HANDLE to the layer.

返り値

レイヤのハンドルを返します。

VectorScript Declaration:

FUNCTION   GetLayerCutPlane

( layer:HANDLE ) :REAL ;

Python:

def  vs.GetLayerCutPlane(layer):

   return REAL

Description:

Gets the cut plane of the layer.

説明

レイヤの切断面の高さを返します。

Parameters:

layer

The layer.

レイヤのハンドル

Result:

The cut plane of the layer.

返り値

レイヤの切断面の高さ

See Also:

SetLayerCutPlane  

VectorScript Declaration:

PROCEDURE   GetLayerElevation

(   h :HANDLE;   VAR  baseElev :REAL;   VAR  thickness :REAL ) ;

Python:

def  vs.GetLayerElevation(h):

   return (baseElev, thickness)

Description:

Gets the elevation and thickness of the specified layer.

説明

ハンドルで指定したレイヤの高さ（Z）と厚み（ΔZ）を返します。

Parameters:

h	Handle to the layer	レイヤのハンドル
baseElev	Base elevation of the layer	高さ（Z）
thickness	Thickness of the layer	厚み（ΔZ）

Example:

PROCEDURE Example;
VAR
	h :HANDLE; 
	baseElev, thickness :REAL;
BEGIN
	h := FLayer;
	WHILE h <> NIL DO BEGIN
		GetLayerElevation(h, baseElev, thickness);
		thickness := thickness / (25.4 / GetPrefReal(152));
		AlrtDialog(Concat('layer name: ', GetLName(h), ', baseElev: ', baseElev, ', thickness: ', thickness));
		h := NextLayer(h);
	END;
END;
RUN(Example);

See Also:

SetLayerElevation  

VectorScript Declaration:

PROCEDURE   GetLayerElevationN

(   h :HANDLE;   VAR  baseElev :REAL;   VAR  thickness :REAL ) ;

Python:

def  vs.GetLayerElevationN(h):

   return (baseElev, thickness)

Description:

Gets the elevation and thickness of the specified layer in document units.

説明

ハンドルで指定したレイヤの高さと壁の高さをファイルの単位で返します。

Parameters:

h	Handle to the layer.	レイヤのハンドル
baseElev	Base elevation of the layer in document units.	ファイルの単位でのレイヤの高さ
thickness	Thickness of the layer in document units.	ファイルの単位での壁の高さ

Example:

PROCEDURE Example;
VAR
	h :HANDLE; 
	baseElev, thickness :REAL;
BEGIN
	h := FLayer;
	WHILE h <> NIL DO BEGIN
		GetLayerElevationN(h, baseElev, thickness);
		thickness := thickness / (25.4 / GetPrefReal(152));
		AlrtDialog(Concat('layer name: ', GetLName(h), ', baseElev: ', baseElev, ', thickness: ', thickness));
		h := NextLayer(h);
	END;
END;
RUN(Example);

See Also:

SetLayerElevationN  

VectorScript Declaration:

FUNCTION   GetLayerEnableCutPl

( layer:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetLayerEnableCutPl(layer):

   return BOOLEAN

Description:

Gets whether the cut plane of the layer is enabled.

説明

レイヤの切断面が有効になっているかどうかを取得します。

Parameters:

layer

The layer.

レイヤのハンドル

Result:

Whether the cut plane of the layer is enabled.

返り値

レイヤの切断面が有効になっているかどうか

See Also:

SetLayerEnableCutPl  

VectorScript Declaration:

FUNCTION   GetLayerForStory

(   story :HANDLE;     levelType :STRING ) :HANDLE ;

Python:

def  vs.GetLayerForStory(story, levelType):

   return HANDLE

Description:

Gets the layer with the story and layer level type specified.

説明

指定したストーリとレベルタイプをを持つレイヤを返します。

Parameters:

story	The Story for which the will be looked up for level types.	ストーリ
levelType	The level type of the story, which associated layer will be returned.	レベルタイプ

Result:

The Layer associated with the Story and layer level specified, which may be NULL.

返り値

指定したストーリとレベルタイプをを持つレイヤを返します。NULLの場合もあります。

Example:

VAR

layer:HANDLE;

BEGIN

layer:=GetLayerForStory(story);

See Also:

GetStoryOfLayer   GetNumStories   CreateStory   AssociateLayerWithStory  

VectorScript Declaration:

FUNCTION   GetLayerLevelType

( layer:HANDLE ) :STRING ;

Python:

def  vs.GetLayerLevelType(layer):

   return STRING

Description:

Returns the Layer Level Type of the Layer.

説明

レイヤのレベルタイプを返します。

Parameters:

layer

The Layer whose Layer Level Type is desired.

レベルタイプを求めるレイヤ。

Result:

The Layer Level Type of the Layer.

返り値

レイヤのレベルタイプを返します。

Example:

VAR

layerLevelType:STRING;

BEGIN

layerLevelType := GetLayerLevelType(ActLayer);

See Also:

SetLayerLevelType   CreateLayerLevelType  

VectorScript Declaration:

FUNCTION   GetLayerOptions

:INTEGER ;

Python:

def  vs.GetLayerOptions():

   return INTEGER

Description:

Returns layer visibility setting for the active document.

Visibility	Index
Active Only	1
Gray Others	2
Gray/Snap Others	6
Show Others	3
Show/Snap Others	4
Show/Snap/Modify Others	5

説明

アクティブなドキュメントの、他のレイヤの表示方法を値で返します。

Result:

Returns an INTEGER indicating the layer visibility status of the document.

返り値

レイヤ表示値を返します。

See Also:

SetLayerOptions  

VectorScript Declaration:

FUNCTION   GetLayerRenderMode

( theLayer:HANDLE ) :INTEGER ;

Python:

def  vs.GetLayerRenderMode(theLayer):

   return INTEGER

Description:

Returns the render mode for the referenced layer.

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

説明

ハンドルで指定したレイヤのレンダリングモードを返します。

VectorScript Declaration:

FUNCTION   GetLayerTransparency

:REAL ;

Python:

def  vs.GetLayerTransparency():

   return REAL

Description:

Return the tranparency of the current layer.

説明

現在のレイヤの透明度を返します。

See Also:

SetLayerTransparency  

VectorScript Declaration:

FUNCTION   GetLevelElevation

(   storyHandle :HANDLE;     levelType :STRING ) :REAL ;

Python:

def  vs.GetLevelElevation(storyHandle, levelType):

   return REAL

Description:

Gets the elevation of a Story Level, relative to its containing Story.

説明

ハンドルで指定したストーリ内のストーリレベルタイプの高さを返します。

Parameters:

storyHandle	The handle of the Story containing the Story Level we would like to know the elevation of.	ストーリのハンドル
levelType	The level type of the Story Level that we would like to know the elevation of.	レベルタイプの名前

Result:

The elevation of the requested Story Level.

返り値

ストーリレベルタイプの高さを返します。

See Also:

CreateStory   AddStoryLevel   RemoveStoryLevel   AddLevelFromTemplate   SetLevelElevation  

VectorScript Declaration:

FUNCTION   GetLevelElevationN

(   storyHandle :HANDLE;     levelType :STRING ) :REAL ;

Python:

def  vs.GetLevelElevationN(storyHandle, levelType):

   return REAL

Description:

Gets the elevation of a Story Level, relative to its containing Story. The elevation is in document units.

説明

ハンドルで指定したストーリレベルのストーリ内での高さを、ファイルの単位で返します。

Parameters:

storyHandle	The handle of the Story containing the Story Level we would like to know the elevation of.	高さを求めるストーリレベルが属するストーリのハンドル
levelType	The level type of the Story Level that we would like to know the elevation of.	高さを求めるレベルタイプの名前

Result:

The elevation of the requested Story Level in document units.

返り値

指定したストーリレベルの高さを、ファイルの単位で返します。

See Also:

CreateStory   AddStoryLevelN   RemoveStoryLevel   AddLevelFromTemplate   SetLevelElevationN  

VectorScript Declaration:

FUNCTION   GetLevelTemplateInfo

(   index :INTEGER;   VAR  layerName :STRING;   VAR  scaleFactor :REAL;   VAR  levelType :STRING;   VAR  elevation :REAL;   VAR  wallHeight :REAL ) :BOOLEAN ;

Python:

def  vs.GetLevelTemplateInfo(index):

   return (BOOLEAN, layerName, scaleFactor, levelType, elevation, wallHeight)

Description:

Used to access the properties of the Story Level Template at 'index'. The name, scaleFactor, levelType, elevation, and wallHeight parameters of the requested Story Level Template will be returned in the appropriate parameters.

説明

指定したインデックスのストーリレベルテンプレートの詳細を返します。 関連付けるレイヤの名前、レイヤの縮尺、レベルタイプ、ストーリレベルの高さ、および壁の高さのプロパティの設定値を返します。

Parameters:

index	The index of the desired Story Level Template.	ストーリレベルテンプレートのインデックス
layerName	The layer name associated with the Story Level Template at 'index'. If this is empty, the corresponding Story Level Template does not use or create a layer.	レイヤの名前 空白の場合関連レイヤが存在しない
scaleFactor	The scale of the layer associated with the Story Level Template at 'index'. If this layer name is blank, this parameter has no use.	レイヤの縮尺 レイヤの名前が空白の場合無効
levelType	The level type of the Story Level Template at 'index'.	レベルタイプの名前
elevation	The elevation of the Story Level Template at 'index'.	ストーリレベルの高さ
wallHeight	The wall height of the Story Level Template at 'index'. If the layer name is blank, this parameter has no meaning.	レイヤの壁の高さ レイヤの名前が空白の場合無効

Result:

Whether the Story Level Template at 'index' was found and valid.

返り値

指定したインデックスのストーリレベルテンプレートが存在し、設定値を正しく取得できたかどうかを返します。

See Also:

GetNumLevelTemplates   GetLevelTemplateName   SetLevelTemplateName   CreateLevelTemplate   DeleteLevelTemplate   GetLevelTemplateInfo  

VectorScript Declaration:

FUNCTION   GetLevelTemplateName

( index:INTEGER ) :STRING ;

Python:

def  vs.GetLevelTemplateName(index):

   return STRING

Description:

Returns the name of the nth Story Level Template in the file. For example, if 3 is passed in, it will return the name of the 3rd Story Level Template in the file.

説明

アクティブなファイルのストーリレベルテンプレートのリストのうち指定したインデックスの名前を返します。

Parameters:

index

The index of the Story Level Template whose name is to be returned.

ストーリレベルテンプレートのインデックス

Result:

The name of the Story Level Template at 'index',

返り値

指定したストーリレベルテンプレートの名前を返します。

Example:

VAR

templateName:STRING;

BEGIN

templateName:=GetLevelTemplateName(2);

See Also:

GetNumLevelTemplates   SetLevelTemplateName   CreateLevelTemplate   DeleteLevelTemplate   GetLevelTemplateInfo  

VectorScript Declaration:

FUNCTION   GetLevelTmpltInfoN

(   index :INTEGER;   VAR  layerName :STRING;   VAR  scaleFactor :REAL;   VAR  levelType :STRING;   VAR  elevation :REAL;   VAR  wallHeight :REAL ) :BOOLEAN ;

Python:

def  vs.GetLevelTmpltInfoN(index):

   return (BOOLEAN, layerName, scaleFactor, levelType, elevation, wallHeight)

Description:

Used to access the properties of the Story Level Template at 'index'. The name, scaleFactor, levelType, elevation, and wallHeight parameters of the requested Story Level Template will be returned in the appropriate parameters.

説明

指定したインデックスのストーリレベルテンプレートの詳細を返します。 関連付けるレイヤの名前、レイヤの縮尺、レベルタイプ、ストーリレベルの高さ、および壁の高さのプロパティの設定値を返します。

Parameters:

index	The index of the desired Story Level Template.	ストーリレベルテンプレートのインデックス
layerName	The layer name associated with the Story Level Template at 'index'. If this is empty, the corresponding Story Level Template does not use or create a layer.	インデックスで指定したストーリレベルテンプレートに関連するレイヤの名前 空白の場合、レイヤが存在しません。
scaleFactor	The scale of the layer associated with the Story Level Template at 'index'. If this layer name is blank, this parameter has no use.	インデックスで指定したストーリレベルテンプレートに関連するレイヤの縮尺 レイヤの名前が空白の場合、戻り値はありません。
levelType	The level type of the Story Level Template at 'index'.	インデックスで指定したストーリレベルのレベルタイプの名前
elevation	The elevation of the Story Level Template at 'index'. The elevation is in document units.	インデックスで指定したストーリレベルの高さ ファイルの単位で戻ります。
wallHeight	The wall height of the Story Level Template at 'index'. The wall height is in document untis. If the layer name is blank, this parameter has no meaning.	インデックスで指定したストーリレベルの壁の高さ 壁の高さはファイルの単位で戻り、レイヤ名が空白の場合、戻り値はありません。

Result:

Whether the Story Level Template at 'index' was found and valid.

返り値

指定したインデックスのストーリレベルが存在し、設定値を正しく取得できたかどうかを返します。

See Also:

GetNumLevelTemplates   GetLevelTemplateName   SetLevelTemplateName   CreateLevelTemplateN   DeleteLevelTemplate  

VectorScript Declaration:

FUNCTION   GetLevelTypeName

( index:INTEGER ) :STRING ;

Python:

def  vs.GetLevelTypeName(index):

   return STRING

Description:

Returns the name of the nth Level Type in the file. For example, if 3 is passed in, it will return the name of the 3rd Level Type in the file.

説明

指定したレベルタイプの名前を返します。

Parameters:

index

The index of the level type whose name is desired.

レベルタイプの番号

Result:

The name of the indicated level type.

返り値

指定したレベルタイプの名前を返します。

Example:

VAR

levelTypeName:STRING;

BEGIN

levelTypeName:=GetLayerLevelTypeName(2);

See Also:

GetNumLayerLevelTypes   SetLevelTypeName  

VectorScript Declaration:

FUNCTION   GetLName

( h:HANDLE ) :STRING ;

Python:

def  vs.GetLName(h):

   return STRING

Description:

Function GetLName returns the name of the referenced layer.

説明

ハンドルで指定したレイヤの名前を返します。

Parameters:

h

Handle to layer.

レイヤのハンドル

VectorScript Declaration:

FUNCTION   GetLScale

( h:HANDLE ) :REAL ;

Python:

def  vs.GetLScale(h):

   return REAL

Description:

Function GetLScale returns the scale of the referenced layer.

説明

ハンドルで指定したレイヤの縮尺を返します。

Parameters:

h

Handle to layer.

レイヤのハンドル

VectorScript Declaration:

FUNCTION   GetLVis

( h:HANDLE ) :INTEGER ;

Python:

def  vs.GetLVis(h):

   return INTEGER

Description:

Function GetLVis returns the visibility of the referenced layer.

Table - Layer Visibility

Visibility	Index Value
Normal	0
Grayed	2
Invisible	-1

説明

ハンドルで指定したレイヤの表示状態を返します。

Parameters:

h

Handle to layer.

レイヤのハンドル

Example:

FUNCTION GetLayerVisibility(layerHandle :handle) :INTEGER;
	{Returns the effective visibility of a layer.}
BEGIN
	GetLayerVisibility := -1;
	IF layerHandle = ActLayer THEN GetLayerVisibility := 0 ELSE {Active layers are always visible.}
	IF (GetObjectVariableInt(ActLayer, 154) = 1) & (GetObjectVariableInt(layerHandle, 154) = 1) THEN BEGIN
		{If it's not the active layer, then the only way that it can be visible is if
		the active layer is a design layer, and so is layerHandle, and the combination
		of layer options and the layer's visibility will result in a visible layer.}
		IF (GetLayerOptions = 2) & (GetLVis(layerHandle) = 2) THEN GetLayerVisibility := 2 ELSE
		IF (GetLayerOptions = 2) & (GetLVis(layerHandle) = 0) THEN GetLayerVisibility := 2 ELSE
		IF (GetLayerOptions > 2) & (GetLVis(layerHandle) = 2) THEN GetLayerVisibility := 2 ELSE
		IF (GetLayerOptions > 2) & (GetLVis(layerHandle) = 0) THEN GetLayerVisibility := 0;
	END;
END;


PROCEDURE Example;
BEGIN
	Message(GetLVis(GetLayerByName('Layer-1')));
END;
RUN(Example);

VectorScript Declaration:

FUNCTION   GetNumLayerLevelTypes

:INTEGER ;

Python:

def  vs.GetNumLayerLevelTypes():

   return INTEGER

Description:

Returns the number of layer level types in the file. A layer can be assigned a layer level type, which defines its location within a story.

説明

ファイルにあるレベルタイプの数を返します。

Result:

The number of layer level types in the file.

返り値

ファイルにあるレベルタイプの数。

See Also:

GetLayerLevelType   SetLayerLevelType   CreateLayerLevelType  

VectorScript Declaration:

FUNCTION   GetNumLevelTemplates

:INTEGER ;

Python:

def  vs.GetNumLevelTemplates():

   return INTEGER

Description:

Returns the number of story level templates in the file. Story Levels contain a level type, elevation, and optional layer to be used to bound objects on stories; Story Level Templates define a generic level that can be added to multiple stories.

説明

ファイル内のストーリレベルテンプレートの数を返します。 ストーリーレベルにはレベルタイプ、高さ、関連付けるレイヤが含まれています。 ストーリレベルテンプレートは複数のストーリに追加できる一般的なレベルを定義します。

Result:

The number of Story Level Templates in the document.

返り値

ファイル内のストーリレベルテンプレートの数を返します。

See Also:

GetLevelTemplateName   SetLevelTemplateName   CreateLevelTemplate   DeleteLevelTemplate   GetLevelTemplateInfo  

VectorScript Declaration:

FUNCTION   GetNumStories

:INTEGER ;

Python:

def  vs.GetNumStories():

   return INTEGER

Description:

Returns the number of stories in the file. Stories are used to group layers and are shown on the Story pane of the Organization dialog.

説明

ファイルにあるストーリの数を返します。

Result:

Returns the number of stories in the file.

返り値

ファイルにあるストーリの数。

See Also:

CreateStory   GetStoryOfLayer   AssociateLayerWithStory  

VectorScript Declaration:

FUNCTION   GetNumStoryLayerTemplates

:INTEGER ;

Python:

def  vs.GetNumStoryLayerTemplates():

   return INTEGER

Description:

Returns the number of story layer templates in the file. Story Layer Templates are used to define what Layers are typically found in a Story. When a Story is created, the user has the option to automatically create the Layers defined by the Story Layer Templates.

説明

ファイルにあるストーリレイヤテンプレートの数を返します。

Result:

The number of Story Layer Templates in the file.

返り値

ファイルにあるストーリレイヤテンプレートの数。

See Also:

CreateStoryLayerTemplate  

VectorScript Declaration:

FUNCTION   GetSheetLayerUserOrigin

(   layerHandle :HANDLE;   VAR  xOrigin :REAL;   VAR  yOrigin :REAL ) :BOOLEAN ;

Python:

def  vs.GetSheetLayerUserOrigin(layerHandle):

   return (BOOLEAN, xOrigin, yOrigin)

Description:

Gets the user origin of the specified sheet layer.

説明

指定したシートレイヤの原点を返します。

Parameters:

layerHandle	Handle of the layer.	レイヤのハンドル
xOrigin	X component of the sheet layer user origin.	原点のX座標
yOrigin	Y component of the sheet layer user origin.	原点のY座標

VectorScript Declaration:

FUNCTION   GetStoryAbove

( story:HANDLE ) :HANDLE ;

Python:

def  vs.GetStoryAbove(story):

   return HANDLE

Description:

Returns the Story above the indicated Story. Returns NULL if there is none. If passed a NULL handle, returns the top-most Story in the current drawing.

説明

指定したストーリの上のストーリを返します。見つからない場合はNULLを返します。ハンドルがNULLの場合は一番上のストーリを返します

Parameters:

story

The indicated Story for which the Story above it is desired.

指定したストーリ

Result:

The Story above the indicated Story, or NULL if there is none. If a NULL handle is passed in, the topmost Story in the current drawing.

返り値

指定したストーリの上のストーリを返します。見つからない場合はNULLを返します。ハンドルがNULLの場合は一番上のストーリを返します

Example:

VAR

baseStory:HANDLE;
storyAbove:HANDLE;

BEGIN

baseStory := GetStoryOfLayer(ActLayer);
storyAbove := StoryAbove(baseStory);

See Also:

GetStoryBelow   GetNumStories   GetStoryOfLayer  

VectorScript Declaration:

FUNCTION   GetStoryBelow

( story:HANDLE ) :HANDLE ;

Python:

def  vs.GetStoryBelow(story):

   return HANDLE

Description:

Returns the Story below the indicated Story. Returns NULL if there is none. If passed a NULL handle, returns the bottom-most Story in the current drawing.

説明

指定したストーリの下のストーリを返します。見つからない場合はNULLを返します。ハンドルがNULLの場合は一番下のストーリを返します。

Parameters:

story

The indicated Story for which the Story below it is desired

指定したストーリ

Result:

The Story below the indicated Story, or NULL if there is none. If a NULL handle is passed in, the bottom-most Story in the current drawing.

返り値

指定したストーリの下のストーリを返します。見つからない場合はNULLを返します。ハンドルがNULLの場合は一番下のストーリを返します。

Example:

VAR

baseStory:HANDLE;
storyBelow:HANDLE;

BEGIN

baseStory := GetStoryOfLayer(ActLayer);
storyBelow := StoryBelow(baseStory);

See Also:

GetStoryAbove   GetNumStories   GetStoryOfLayer  

VectorScript Declaration:

FUNCTION   GetStoryElevation

( story:HANDLE ) :REAL ;

Python:

def  vs.GetStoryElevation(story):

   return REAL

Description:

Returns the elevaton of the indicated Story.

説明

指定したストーリの高さを返します。

Parameters:

story

The Story whose elevation is desired.

高さを求めたいストーリ

Result:

The elevation of the Story.

返り値

ストーリの高さ

See Also:

CreateStory   SetStoryElevation  

VectorScript Declaration:

FUNCTION   GetStoryElevationN

( story:HANDLE ) :REAL ;

Python:

def  vs.GetStoryElevationN(story):

   return REAL

Description:

Returns the elevaton of the indicated Story. The elevation is in document units.

説明

ハンドルで指定したストーリの高さを、ファイルの単位で返します。

Parameters:

story

The Story whose elevation is desired.

高さを求めたいストーリのハンドル

Result:

The elevation of the Story in document units.

返り値

ファイルの単位でのストーリの高さ

See Also:

CreateStory   SetStoryElevationN  

VectorScript Declaration:

FUNCTION   GetStoryLayerTemplateName

( index:INTEGER ) :STRING ;

Python:

def  vs.GetStoryLayerTemplateName(index):

   return STRING

Description:

Returns the name of the nth Story Layer Template in the file. For example, if 3 is passed in, it will return the name of the 3rd Story Layer Template in the file.

説明

ファイルにあるn番目のストーリレイヤテンプレートの名前を返します。

Parameters:

index

The index of the Story Layer Template whose name is desired.

名前を求めるストーリレイヤテンプレートのインデックス

Result:

The name of the nth Story Layer Template.

返り値

ファイルにあるn番目のストーリレイヤテンプレートの名前を返します。

Example:

VAR

templateName:STRING;

BEGIN

templateName:=GetStoryLayerTemplateName(2);

See Also:

GetNumStoryLayerTemplates   CreateStoryLayerTemplate  

VectorScript Declaration:

FUNCTION   GetStoryOfLayer

( layer:HANDLE ) :HANDLE ;

Python:

def  vs.GetStoryOfLayer(layer):

   return HANDLE

Description:

Returns the Story that the indicated Layer is associated with. Returns NULL if the Layer is not associated with a Story.

説明

指定されたレイヤに関連付けられたストーリを返します。レイヤがストーリに関連付けられていない場合、NULLを返します。

Parameters:

layer

The Layer for which the associated Story is returned.

ストーリに関連付けられたレイヤを返します

Result:

The Story associated with the Layer, which may be NULL.

返り値

レイヤに関連付けられたストーリを返します。

Example:

VAR

story:HANDLE;

BEGIN

story:=GetStoryOfLayer(ActLayer);

See Also:

GetLayerForStory   GetNumStories   CreateStory   AssociateLayerWithStory  

VectorScript Declaration:

FUNCTION   GetStorySuffix

( story:HANDLE ) :STRING ;

Python:

def  vs.GetStorySuffix(story):

   return STRING

Description:

Returns the suffix of the indicated Story.

説明

指定したストーリのレイヤ名の後記号を返します。

Parameters:

story

The Story whose suffix is desired.

後記号を得たいストーリ

Result:

The suffix of the indicated Story.

返り値

指定されたストーリの後記号

See Also:

GetStoryElevation   SetStorySuffix  

VectorScript Declaration:

PROCEDURE   GetZVals

( VAR  zVal :REAL;   VAR  deltaZVal :REAL ) ;

Python:

def  vs.GetZVals():

   return (zVal, deltaZVal)

Description:

Procedure GetZVals returns the Z (layer base elevation) and delta Z (layer thickness) values for the active layer.

説明

アクティブなレイヤの高さ（Z）と厚み（ΔZ）を返します。

Parameters:

zVal	Layer base elevation(above document ground plane).	高さ（Z）
deltaZVal	Layer thickness.	厚み（ΔZ）

Example:

PROCEDURE GetLayerHeights(layerHandle :handle; var baseElev, thickness :REAL);
BEGIN
	GetLayerElevation(layerHandle, baseElev, thickness);
	baseElev  := baseElev  / (25.4 / GetPrefReal(152));
	thickness := thickness / (25.4 / GetPrefReal(152));
END;

VectorScript Declaration:

PROCEDURE   GrayLayer

;

Python:

def  vs.GrayLayer():

   return None

Description:

Procedure GrayLayer sets the visibility status of the active layer to grayed. Objects on grayed layers will always appear grayed when viewed from other layers.

説明

アクティブなレイヤをグレイ表示にします。

Example:

Layer('Future Construction');
GrayLayer;
{grays the layer 'Future Construction'}

VectorScript Declaration:

FUNCTION   HGetLayerTransp

( hLayer:HANDLE ) :REAL ;

Python:

def  vs.HGetLayerTransp(hLayer):

   return REAL

Description:

Get the transparency of the spcified layer.

説明

指定したレイヤの透明度を返します。

Parameters:

hLayer

Handle to the layer.

レイヤのハンドル

See Also:

HSetLayerTransp   GetLayerTransparency  

VectorScript Declaration:

PROCEDURE   HideLayer

;

Python:

def  vs.HideLayer():

   return None

Description:

Procedure HideLayer sets the visibility status of the active layer to hidden. Objects on hidden layers will not be viewable from other layers.

説明

アクティブなレイヤを隠します。

Example:

Layer('Future Construction');
HideLayer;
{hides the layer 'Future Construction'}

VectorScript Declaration:

PROCEDURE   HSetLayerTransp

(   hLayer :HANDLE;     transparency :REAL ) ;

Python:

def  vs.HSetLayerTransp(hLayer, transparency):

   return None

Description:

Set the transparency of the specified layer.

説明

指定したレイヤの透明度を設定します。

Parameters:

hLayer	Handle to the layer.	レイヤのハンドル
transparency	The transparency for the layer. Value between 0.0 and 100.0	透明度を、0から100までの値で指定します。

See Also:

SetLayerTransparency   HGetLayerTransp  

VectorScript Declaration:

FUNCTION   IsLayerReferenced

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

Python:

def  vs.IsLayerReferenced(layer):

   return (BOOLEAN, pathname)

Description:

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

説明

ハンドルで指定したレイヤがファイル共有で参照されているレイヤの場合は、参照元ドキュメントへのパスを返します。

Parameters:

layer	Handle to the layer	レイヤのハンドル
pathname	On return, a string containing the path to the source document	パス

Result:

Returns true if the layer is referenced, false otherwise.

返り値

TRUE：レイヤが参照されています。
FALSE：レイヤが参照されていません。

VectorScript Declaration:

PROCEDURE   Layer

( name:STRING ) ;

Python:

def  vs.Layer(name):

   return None

Description:

Procedure Layer creates a new layer in a Vectorworks document. After creation, the new layer becomes the active layer of the document.

Layer can also be used to switch the active layer of the document. If the layer name passed to the procedure already exists, the procedure switches the active layer to the specified layer.

Single quotes should be avoided in layer names, as they will be treated as a mismatched string specifier, and will cause an error to be generated.

説明

新しいレイヤを指定した名前で作成し、そのレイヤをアクティブにします。
指定した名前のレイヤがすでに存在する場合、そのレイヤをアクティブにします。

Parameters:

name

Name of new or existing layer.

レイヤの名前

Example:

Layer('Ductwork-1st Floor');
{creates a new layer named 'Ductwork-1st Floor'}

Layer(newLayerName);
{creates a new layer whose name is specified in the variable}

Layer('Untitled-1');
{switches to the existing layer 'Untitled-1'}

VectorScript Declaration:

PROCEDURE   LayerRef

( layerName:STRING ) ;

Python:

def  vs.LayerRef(layerName):

   return None

Description:

Procedure LayerRef places a layer reference (layer link) into the active layer at location (0,0).

説明

指定したレイヤとアクティブなレイヤを座標(0,0)でリンクさせます。

Parameters:

layerName

Name of referenced layer.

リンク先のレイヤの名前

Example:

LayerRef('Layer-2');
{creates a layer link of 'Layer-2' on the active layer}

VectorScript Declaration:

PROCEDURE   LFillBack

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

Python:

def  vs.LFillBack(color):

   return None

Description:

Procedure LFillBack sets the background fill color for the active layer. RGB values are in the range of 0~65535.

説明

アクティブなレイヤの面の地色を設定します。値の範囲は0から65535までです。

Parameters:

color

RGB color component value.

赤、緑、青の成分

Example:

LFillBack(65535,0,39321);

VectorScript Declaration:

PROCEDURE   LFillFore

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

Python:

def  vs.LFillFore(color):

   return None

Description:

Procedure LFillFore sets the foreground fill color for the active layer. RGB values are in the range of 0~65535.

説明

アクティブなレイヤの面の色を設定します。値の範囲は0から65535までです。

Parameters:

color

RGB color component value.

赤、緑、青の成分

Example:

LFillFore(65535,0,39321);

VectorScript Declaration:

FUNCTION   LLayer

:HANDLE ;

Python:

def  vs.LLayer():

   return HANDLE

Description:

Function LLayer returns a handle to the last layer in a Vectorworks document.

説明

最下位のレイヤのハンドルを返します。

返り値

レイヤのハンドル

VectorScript Declaration:

PROCEDURE   LPenBack

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

Python:

def  vs.LPenBack(color):

   return None

Description:

Procedure LPenBack sets the background pen color for the active layer. RGB values are in the range of 0~65535.

説明

アクティブなレイヤの線の地色を設定します。値の範囲は0から65535までです。

Parameters:

color

RGB color component value.

赤、緑、青の成分

VectorScript Declaration:

PROCEDURE   LPenFore

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

Python:

def  vs.LPenFore(color):

   return None

Description:

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

説明

アクティブなレイヤの線の色を設定します。値の範囲は0から65535までです。

Parameters:

color

RGB color component value.

赤、緑、青の成分

VectorScript Declaration:

FUNCTION   NumLayers

:INTEGER ;

Python:

def  vs.NumLayers():

   return INTEGER

Description:

Function NumLayers returns the current number of layers within the active document.

説明

アクティブなドキュメント内のレイヤの数を返します。

返り値

レイヤの数

VectorScript Declaration:

FUNCTION   NumObj

( h:HANDLE ) :LONGINT ;

Python:

def  vs.NumObj(h):

   return LONGINT

Description:

Function NumObj returns the number of objects on the referenced layer.

説明

ハンドルで指定したレイヤ上の図形の数を返します。

Parameters:

h

Handle to layer.

レイヤのハンドル

返り値

図形の数

VectorScript Declaration:

FUNCTION   RemoveStoryLevel

(   storyHandle :HANDLE;     levelType :STRING;     bDeleteLayer :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.RemoveStoryLevel(storyHandle, levelType, bDeleteLayer):

   return BOOLEAN

Description:

Removes the Story Level matching 'levelType' from a Story. If 'bDeleteLayer' is true and the Story Level has an associated layer, the layer will be deleted as well.

説明

ストーリから指定したレベルタイプのストーリレベルを削除します。 'bDeleteLayer' をTRUEにすると、関連付けられているレイヤも削除します。

Parameters:

storyHandle	The handle of the story we want to deleted a Story Level from.	ストーリレベルのハンドル
levelType	The level type of the Story Level we want to remove from 'storyHandle'.	レベルタイプの名前
bDeleteLayer	If this is true, and the requested Story Level has a layer associated with it, the layer will be deleted as well.	レイヤを削除する(TRUE)／しない(FALSE)

Result:

Whether a Story Level with 'layerType' was found in the Story and successfully removed.

返り値

ストーリレベルが正しく削除されたかどうかを返します。

Example:

VAR

storyHandle : HANDLE
success:BOOLEAN

BEGIN

storyHandle := CreateStory('Floor 1', '-1');
success := RemoveStoryLevel(storyHandle, 'Finish Floor', TRUE);

See Also:

CreateStory   AddStoryLevel   AddLevelFromTemplate   SetLevelElevation   GetLevelElevation  

VectorScript Declaration:

FUNCTION   ResetDefStoryLevels

( bDeleteExisting:BOOLEAN ) :BOOLEAN ;

Python:

def  vs.ResetDefStoryLevels(bDeleteExisting):

   return BOOLEAN

Description:

Clears default story levels and repopulates the list from XML data files on disk.

説明

デフォルトのストーリレベルをすべて消去し、ディスク上のXMLデータファイルから再生成します。

Parameters:

bDeleteExisting

Whether to delete existing default story levels before reloading the original defaults.

デフォルトのストーリレベルを再生成する前に、既存のストーリレベルを削除する(TRUE)／しない(FALSE)

Result:

Whether clearing the previous default story levels and loading the default list from disk succeeded.

返り値

既存のデフォルトのストーリレベルが消去され、ディスクから再生成されたかどうかを返します。

See Also:

GetLevelTemplateName   SetLevelTemplateName   GetLevelTemplateInfo   GetNumLevelTemplates  

VectorScript Declaration:

FUNCTION   SetDefStoryLayerName

(   index :INTEGER;     name :STRING ) :BOOLEAN ;

Python:

def  vs.SetDefStoryLayerName(index, name):

   return BOOLEAN

Description:

Sets the name of the nth Default Story Layer in the file. For example, if 3 is passed in, it will set the name of the 3rd Default Story Layer in the file.

説明

指定したストーリレイヤ初期設定の名前を設定します。

Parameters:

index	The index of the default story layer whose name should be set.	ストーリレイヤの番号
name	The name that the indicated default story layer should be set to.	初期設定の名前

Result:

Whether the setting of the name of the default story layer succeeded. It will fail if passed an invalid index. The name must not have more than 63 characters and must not be used by another default story layer in the file.

返り値

名前が設定できたかどうかを返します。名前は63文字以下で、他のストーリレイヤと重複してはいけません

Example:

VAR

result : BOOLEAN;

BEGIN

result := SetStoryLayerTemplateName(2, "Subfloor");

See Also:

GetNumStoryLayerTemplates   GetStoryLayerTemplateName  

VectorScript Declaration:

PROCEDURE   SetLayerCutPlane

(   layer :HANDLE;     cutPlane :REAL (Coordinate) ) ;

Python:

def  vs.SetLayerCutPlane(layer, cutPlane):

   return None

Description:

Sets the cut plane of the layer.

説明

レイヤの切断面の高さを設定します。

Parameters:

layer	The layer.	レイヤのハンドル
cutPlane	The cut plane.	レイヤの切断面の高さ

See Also:

GetLayerCutPlane  

VectorScript Declaration:

PROCEDURE   SetLayerElevation

(   h :HANDLE;     baseElev :REAL;     thickness :REAL ) ;

Python:

def  vs.SetLayerElevation(h, baseElev, thickness):

   return None

Description:

Sets the elevation and thickness of the specified layer.

説明

ハンドルで指定したレイヤの高さ（Z）と厚み（ΔZ）を設定します。

Parameters:

h	Handle to the layer	レイヤのハンドル
baseElev	Base elevation of the layer	高さ（Z）
thickness	Thickness of the layer	厚み（ΔZ）

See Also:

GetLayerElevation  

VectorScript Declaration:

PROCEDURE   SetLayerElevationN

(   h :HANDLE;     baseElev :REAL;     thickness :REAL ) ;

Python:

def  vs.SetLayerElevationN(h, baseElev, thickness):

   return None

Description:

Sets the elevation and thickness of the specified layer.

説明

ハンドルで指定したレイヤの高さと壁の高さを設定します。

Parameters:

h	Handle to the layer.	レイヤのハンドル
baseElev	Base elevation of the layer in document units.	ファイルの単位でのレイヤの高さ
thickness	Thickness of the layer in document units.	ファイルの単位での壁の高さ

See Also:

GetLayerElevationN  

VectorScript Declaration:

PROCEDURE   SetLayerEnableCutPl

(   layer :HANDLE;     enableCutPlane :BOOLEAN ) ;

Python:

def  vs.SetLayerEnableCutPl(layer, enableCutPlane):

   return None

Description:

Sets whether the cut plane of the layer is enabled.

説明

レイヤの切断面を有効にするかどうか設定します。

Parameters:

layer	The layer.	レイヤのハンドル
enableCutPlane	Whether the cut plane is enabled.	レイヤの切断面を有効/無効

See Also:

GetLayerEnableCutPl  

VectorScript Declaration:

FUNCTION   SetLayerLevelType

(   layer :HANDLE;     layerLevelType :STRING ) :BOOLEAN ;

Python:

def  vs.SetLayerLevelType(layer, layerLevelType):

   return BOOLEAN

Description:

Sets the Layer Level Type of a Layer. If the type passed in does not exist or if it already used by another Layer on the same Story, then the operation will fail.

説明

レイヤのレベルタイプを設定します。もし、タイプが存在しないか、同じストーリの他のレイヤに使用されている場合は失敗します。

Parameters:

layer	The Layer for which the Layer Level Type is being set.	レイヤレベルタイプを設定するレイヤ
layerLevelType	The Layer Level Type.	レイヤレベルタイプ

Result:

Whether the attempt to set the Layer Level Type was successful.

返り値

設定が成功したかどうかを返します。

Example:

SetLayerLevelType(ActLayer, 'LT_SLAB');

See Also:

GetLayerLevelType   CreateLayerLevelType  

VectorScript Declaration:

PROCEDURE   SetLayerOptions

( layerOpts:INTEGER ) ;

Python:

def  vs.SetLayerOptions(layerOpts):

   return None

Description:

Sets layer visibility setting for the active document.

Visibility	Index
Active Only	1
Gray Others	2
Gray/Snap Others	6
Show Others	3
Show/Snap Others	4
Show/Snap/Modify Others	5

説明

他のレイヤの表示状態を設定します。

Parameters:

layerOpts

New layer visibility setting for document.

表示状態

See Also:

GetLayerOptions  

VectorScript Declaration:

PROCEDURE   SetLayerRenderMode

(   theLayer :HANDLE;     newRenderMode :INTEGER;     immediate :BOOLEAN;     doProgress :BOOLEAN ) ;

Python:

def  vs.SetLayerRenderMode(theLayer, newRenderMode, immediate, doProgress):

   return None

Description:

Sets the render mode of the referenced layer.

説明

レイヤのレンダリングモードを設定します。

Parameters:

theLayer	Handle of the layer	レイヤのハンドル
newRenderMode	New render mode to set	レンダリングモード
immediate	If true, then all rendering will take place before the call returns. Otherwise, any rendering that can take place in the background will be postponed until program execution re-enters the main event loop	すぐに実行する場合はTRUE
doProgress	controls whether progress information is displayed during the operation	進行状況を表示する場合はTRUE

VectorScript Declaration:

PROCEDURE   SetLayerTransparency

( transparency:REAL ) ;

Python:

def  vs.SetLayerTransparency(transparency):

   return None

Description:

Procedure SetLayerTransparency assigns a transparency percentage value to the active design layer. If a sheet layer is active, the procedure has no effect. The transparency value must be between 0.0 and 100.0, inclusive.

The design layer will only be imaged with transparency on systems which support it, like Quartz on the Mac. Setting the transparency to a value greater than 0, when the current transfer mode is Copy (i.e. 8, Paint mode), will also automatically change the layer transfer mode to OR (i.e. 9, Overlay). Similarly, setting the transparency to 0, when the current transfer mode is not set to Copy, will also automatically change the layer transfer mode to Copy. This is to approximately preserve the appearance of the drawing when imaging on systems that don't support transparency, like Windows.

説明

アクティブなデザインレイヤの透明度（％）を設定します。
シートレイヤがアクティブの場合は影響しません。透明度（％）は0.0～100.0までの値で指定しなければなりません。

See Also:

CopyMode  

VectorScript Declaration:

FUNCTION   SetLevelElevation

(   storyHandle :HANDLE;     levelType :STRING;     newElevation :REAL ) :BOOLEAN ;

Python:

def  vs.SetLevelElevation(storyHandle, levelType, newElevation):

   return BOOLEAN

Description:

Sets the elevation of a Story Level relative to its Story.

説明

指定したストーリ内のストーリレベルタイプの高さを設定します。

Parameters:

storyHandle	The handle of the Story with the desired Story Level.	ストーリレベルのハンドル
levelType	The level type of the Story Level to change the elevation of.	レベルタイプの名前
newElevation	The new elevation for the Story Level.	ストーリレベルの高さ

Result:

Whether the Story Level was found and successfully updated.

返り値

指定したストーリレベルが存在し、正しく設定されたかどうかを返します。

See Also:

CreateStory   AddStoryLevel   RemoveStoryLevel   AddLevelFromTemplate   GetLevelElevation  

VectorScript Declaration:

FUNCTION   SetLevelElevationN

(   storyHandle :HANDLE;     levelType :STRING;     newElevation :REAL ) :BOOLEAN ;

Python:

def  vs.SetLevelElevationN(storyHandle, levelType, newElevation):

   return BOOLEAN

Description:

Sets the elevation of a Story Level relative to its Story.

説明

ハンドルで指定したストーリレベルのストーリ内での高さを、ファイルの単位で設定します。

Parameters:

storyHandle	The handle of the Story with the desired Story Level.	高さを設定するストーリレベルが属するストーリのハンドル
levelType	The level type of the Story Level to change the elevation of.	高さを設定するレベルタイプの名前
newElevation	The new elevation for the Story Level. The elevation is in document units.	設定するストーリレベルの高さ ファイルの単位で指定します。

Result:

Whether the Story Level was found and successfully updated.

返り値

ストーリレベルが存在し、正しく設定できたかを返します。

See Also:

CreateStory   AddStoryLevelN   RemoveStoryLevel   AddLevelFromTemplate   GetLevelElevationN  

VectorScript Declaration:

FUNCTION   SetLevelTemplateName

(   index :INTEGER;     name :STRING ) :BOOLEAN ;

Python:

def  vs.SetLevelTemplateName(index, name):

   return BOOLEAN

Description:

Sets the name of the Story Level Template at 'index' to be 'name'.

説明

インデックスで指定したストーリレベルテンプレートの名前を設定します。

Parameters:

index	The index of the Story Level Template.	ストーリレベルテンプレートのインデックス
name	The new name for the Story Level Template at 'index'.	ストーリレベルテンプレートの名前

Result:

Whether the function succeeded in setting the name.

返り値

正しく名前が設定されたかどうかを返します。

Example:

VAR

result : BOOLEAN;

BEGIN

result := SetLevelTemplateName(2, "Subfloor");

See Also:

GetNumLevelTemplates   GetLevelTemplateName   SetLevelTemplateName   CreateLevelTemplate   DeleteLevelTemplate   GetLevelTemplateInfo  

VectorScript Declaration:

FUNCTION   SetLevelTypeName

(   index :INTEGER;     name :STRING ) :BOOLEAN ;

Python:

def  vs.SetLevelTypeName(index, name):

   return BOOLEAN

Description:

Sets the name of the nth Level Type in the file. For example, if 3 is passed in, it will set the name of the 3rd Level Type in the file.

説明

指定したレベルタイプの名前を設定します。

Parameters:

index	The index of the level type whose name is being set.	レベルタイプ
name	The name the indicated level type should be set to.	設定する名前

Result:

Whether the setting of the name of the level type succeeded. It will fail if passed an invalid index. The name must not have more than 63 characters and must not be used by another level type in the file.

返り値

名前が設定できたかどうかを返します。名前は63文字以下で、他のレベルタイプと重複してはいけません。

Example:

VAR

result : BOOLEAN;

BEGIN

result := SetLayerLevelTypeName(2, "Subfloor");

See Also:

GetNumLayerLevelTypes   GetLevelTypeName  

VectorScript Declaration:

PROCEDURE   SetLScale

(   h :HANDLE;     scale :REAL ) ;

Python:

def  vs.SetLScale(h, scale):

   return None

Description:

Procedure SetLScale sets the scale of the referenced layer.

Calculating the Scale

To calculate the scale parameter from an architecural scale, the following formula may be used :

denominator/numerator * true size(in inches) = ActualSize

For example, to calculate a scale of 3/8"=1'-0", the scale parameter would be 8/3 *12 = 32.

説明

ハンドルで指定したレイヤの縮尺を変更します。

Parameters:

h	Handle to layer.	レイヤのハンドル
scale	Scale value for layer.	縮尺

Example:

SetLScale(HandleToLayer,96);
{sets the referenced layer to a scale of 1/8" = 1'}

VectorScript Declaration:

PROCEDURE   SetScale

( actualSize:REAL ) ;

Python:

def  vs.SetScale(actualSize):

   return None

Description:

Procedure SetScale sets the drawing scale of the active layer of the document.

Calculating the Scale

To calculate the scale parameter from an architecural scale, the following formula may be used :

denominator/numerator * true size(in inches) = ActualSize

For example, to calculate a scale of 3/8"=1'-0", the scale parameter would be 8/3 *12 = 32.

説明

アクティブなレイヤの縮尺を設定します。

Parameters:

actualSize

Drawing scale factor.

縮尺

VectorScript Declaration:

FUNCTION   SetSheetLayerUserOrigin

(   layerHandle :HANDLE;     xOrigin :REAL;     yOrigin :REAL ) :BOOLEAN ;

Python:

def  vs.SetSheetLayerUserOrigin(layerHandle, xOrigin, yOrigin):

   return BOOLEAN

Description:

Sets the user origin of the specified sheet layer.

説明

指定したシートレイヤの原点を設定します。

VectorScript Declaration:

FUNCTION   SetStoryElevation

(   story :HANDLE;     elevation :REAL ) :BOOLEAN ;

Python:

def  vs.SetStoryElevation(story, elevation):

   return BOOLEAN

Description:

Sets the elevation of the indicated Story. Returns whether the elevation was successfully set. If the elevaton change would cause Layers associated with the Story to overlap Layers associated with another Story, then the change in elevation will be prevented.

説明

指定したストーリの高さを設定します。ストーリの高さが設定出来たかどうかを返します。変更によってストーリに関連付けられているレイヤが他のストーリに関連付けられているレイヤと重なる場合は設定されません。

Parameters:

story	The Story whose elevation is to be set.	高さを設定するストーリ
elevation	The elevation to set the Story to.	ストーリに設定する高さ

Result:

Whether the elevation is successfully changed.

返り値

高さの変更に成功したかどうかを返します。

See Also:

CreateStory   GetStoryElevation  

VectorScript Declaration:

FUNCTION   SetStoryElevationN

(   story :HANDLE;     elevation :REAL ) :BOOLEAN ;

Python:

def  vs.SetStoryElevationN(story, elevation):

   return BOOLEAN

Description:

Sets the elevation of the indicated Story. Returns whether the elevation was successfully set. If the elevaton change would cause Layers associated with the Story to overlap Layers associated with another Story, then the change in elevation will be prevented.

説明

ハンドルで指定したストーリーの高さを設定します。高さが正常に設定されたかどうかを返します。もし、高さの変更によってそのストーリーに関連付けられたレイヤが他のストーリーに関連付けられたレイヤと重なる場合、高さの変更は中止されます。

Parameters:

story	The Story whose elevation is to be set.	高さを設定するストーリのハンドル
elevation	The elevation to set the Story to. The elevation is in document units.	ストーリに設定する高さ ファイルの単位で指定します。

Result:

Whether the elevation is successfully changed.

返り値

高さの変更に成功したかどうかを返します。

See Also:

CreateStory   GetStoryElevationN  

VectorScript Declaration:

FUNCTION   SetStorySuffix

(   story :HANDLE;     suffix :STRING ) :BOOLEAN ;

Python:

def  vs.SetStorySuffix(story, suffix):

   return BOOLEAN

Description:

Sets the suffix of the indicated Story. Returns whether the suffix was successfully set. If the suffix is already used by another Story, then the change in suffix will be prevented.

説明

指定したストーリのレイヤ名の後記号を設定します。後記号が設定出来たかどうかが返ります。後記号が他のストーリに使用されている場合、後記号は変更されません。

Parameters:

story	The story whose suffix is being set.	後記号を設定するストーリ
suffix	The new value of the suffix of the indicated Story.	指定されたストーリの新しい後記号の値

Result:

Whether the suffix is successfully changed.

返り値

後記号が変更出来たかどうか

See Also:

GetStorySuffix   SetStoryElevation  

VectorScript Declaration:

PROCEDURE   SetZVals

(   zDistance :REAL (Coordinate);     deltaZDistance :REAL (Coordinate) ) ;

Python:

def  vs.SetZVals(zDistance, deltaZDistance):

   return None

Description:

Procedure SetZVals sets the Z (layer base elevation) and delta Z (layer thickness) for the active layer.

説明

アクティブなレイヤの高さ（Z）と厚み（ΔZ）を設定します。

Parameters:

zDistance	Layer base elevation (above document ground plane).	高さ（Z）
deltaZDistance	Layer thickness.	厚み（ΔZ）

Example:

PROCEDURE Example;
VAR
   baseElevation, thickness :REAL;
BEGIN
   Layer('Test Layer');
   baseElevation := 1;
   thickness := 3;
   SetZVals(baseElevation, thickness);
END;
RUN(Example);

VectorScript Declaration:

PROCEDURE   ShowLayer

;

Python:

def  vs.ShowLayer():

   return None

Description:

Procedure ShowLayer sets the visibility status of the active layer to visible. Newly created layers always defaulted to the Show mode.

説明

アクティブなレイヤを表示します。

Example:

Layer('Future Construction');
ShowLayer;