VectorScript Declaration:

FUNCTION   AddObjectTo2DComp

(   objectHandle :HANDLE;     objToAddHandle :HANDLE;     component :INTEGER ) :BOOLEAN ;

Python:

def  vs.AddObjectTo2DComp(objectHandle, objToAddHandle, component):

   return BOOLEAN

Description:

Adds an object to the specified 2D component group of a symbol definition or plug-in object. Use Top/Plan if you want to add the the object into the main container of the symbol definition or plug-in object.

Table - 2D Components

2D Component	Constant
Not Set	0
Top	1
Bottom	2
Top and Bottom Cut	3
Front	4
Back	5
Front and Back Cut	6
Left	7
Right	8
Left and Right Cut	9
Top/Plan	10

説明

指定したシンボル定義、またはプラグインオブジェクトの2Dコンポーネントグループにオブジェクトを追加します。シンボル定義またはプラグインオブジェクトのメインコンテナにオブジェクトを追加したい場合は、2D/平面を指定します。

Table - 2D Components

2D Component	Constant
Not Set	0
Top	1
Bottom	2
Top and Bottom Cut	3
Front	4
Back	5
Front and Back Cut	6
Left	7
Right	8
Left and Right Cut	9
Top/Plan	10

Parameters:

objectHandle	Symbol definition or plug-in object.	シンボル定義、またはプラグインオブジェクトのハンドル
objToAddHandle	New object to be added to the 2D component group.	2Dコンポーネントグループのハンドル
component	2D component	2Dコンポーネント

Result:

Returns TRUE if the operation was successful.

返り値

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

See Also:

Set2DComponentGroup   Get2DComponentGroup  

VectorScript Declaration:

FUNCTION   AddToPIOStyleEdit

(   hObj :HANDLE;     keyName :STRING;     editType :INTEGER;     displayName :STRING ) :BOOLEAN ;

Python:

def  vs.AddToPIOStyleEdit(hObj, keyName, editType, displayName):

   return BOOLEAN

Description:

Adds an item to a plug-in style's default edit list. This is only used by objects that use the default edit style dialog.

By default, only those parameters shown in the object info palette will be listed in the edit style mapping dialg. Pass the following values to add or remove an item this list.

Values:
1 - Add to the edit style map dialog.
2 - Remove from the edit stkyle map dialog.


To remove an entry from this list use RemovePIOStyleEdit.

説明

プラグインスタイルの編集マッピングダイアログボックスに項目を追加します。デフォルトのスタイル編集ダイアログボックスを使用するオブジェクトにのみ使用できます。

デフォルトでは、情報パレットに表示されているパラメータのみスタイルマッピング編集ダイアログにリストされます。このリストを追加または削除するには次の値を指定します。

Values:
1 - スタイルマップの編集ダイアログに追加します。
2 - スタイルマッピング編集ダイアログから削除します。


リストから項目を削除する場合は RemovePIOStyleEdit を使用します。

Parameters:

hObj	Handle to a plug-in object or plug-in object style	プラグインオブジェクトまたはプラグインスタイルのハンドル
keyName	Universal name of parameter or iother item to add to the edit style map list	スタイルマッッピング編集リストに追加するパラメータ等の項目のユニバーサル名
editType	1 - Add to edit list 2 - Remove from edit list	1 - 編集リストに追加 2 - 編集リストから削除
displayName	The display name to use in the style map dialog. If an empy string is passed the keyName will be used.	スタイルマップダイアログで表示される名前 空文字を指定した場合 keyName が使用される

Result:

TRUE if key is added to the list.

FALSE if hObj is NULL; if hObj is not a styled plug-in object or plug-in style
FALSE if item already appear in list. Use RemoveFromPluginStyleEditList first.

返り値

項目をリストに追加できた場合TRUEを返します。

指定したハンドルがNULLの場合、指定したハンドルがプラグインオブジェクトかプラグインスタイルのハンドルでない場合はFALSEを返します。
項目がリストに既に追加されている場合はFALSEを返します。先に RemoveFromPluginStyleEditList を実行してください。

See Also:

RemovePIOStyleEdit  

VectorScript Declaration:

FUNCTION   CreateCustomObject

(   objectName :STRING;     pX :REAL;     pY :REAL;     rotationAngle :REAL ) :HANDLE ;

Python:

def  vs.CreateCustomObject(objectName, p, rotationAngle):

   return HANDLE

Description:

Creates a custom object instance at the specified location and angle of rotation. For the objectName, use the "internal" plug-in name (the one assigned in the plug-in editor), as opposed to the filename (which can be different).

説明

位置と角度を指定してプラグインオブジェクトを配置し、そのハンドルを返します。

Parameters:

objectName	Name of object.	プラグインオブジェクトの名前
p	Insertion point of object instance.	配置する座標
rotationAngle	Rotation angle (in degrees) of object instance.	回転角度

Result:

Returns a HANDLE to the new object.

返り値

プラグインオブジェクトのハンドルを返します。

See Also:

CreateCustomObjectPath  

VectorScript Declaration:

FUNCTION   CreateCustomObjectN

(   objectName :STRING;     pX :REAL;     pY :REAL;     rotationAngle :REAL;     showPref :BOOLEAN ) :HANDLE ;

Python:

def  vs.CreateCustomObjectN(objectName, p, rotationAngle, showPref):

   return HANDLE

Description:

Creates a custom object instance at specified location and angle of rotation. The calling function can also set whether the pref dialog should appear.

説明

位置と角度を指定してプラグインオブジェクトを作成し、そのハンドルを返します。また、設定ダイアログの表示／非表示を設定できます。

Parameters:

objectName	Name of object.	プラグインオブジェクトの名前
p	Insertion point of object instance.	配置する座標
rotationAngle	Rotation angle (in degrees) of object instance.	回転角度（度）
showPref	Show the Object Properties dialog.	設定ダイアログの設定（TRUE：表示／FALSE：非表示）

Example:

PROCEDURE Example;
VAR
   h :HANDLE;
BEGIN
   h := CreateCustomObjectN('Door', 0, 0, 0, False);
END;
RUN(Example);

VectorScript Declaration:

FUNCTION   CreateCustomObjectPath

(   objectName :STRING;     path :HANDLE;     profileGroup :HANDLE ) :HANDLE ;

Python:

def  vs.CreateCustomObjectPath(objectName, path, profileGroup):

   return HANDLE

Description:

Creates an instance of the path custom object specified by the name argument. The vertices of the path are translated in such a way that the first vertex will be placed at the origin of the plug-in's coordinate space.

説明

パスを用いたプラグインオブジェクトを作成し、そのハンドルを返します。

Parameters:

objectName	Name of object.	プラグインオブジェクトの名前
path	Handle to new object path polygon.	パス図形（曲線 or NURBS）のハンドル
profileGroup	Handle to new profile group object.	輪郭図形のハンドル

Result:

Returns a HANDLE to the new path object.

返り値

プラグインオブジェクトのハンドルを返します。

Example:

PROCEDURE Example;
VAR
	h :HANDLE;
BEGIN
	CallTool(-204);
	h := CreateCustomObjectPath('Cutting Plane', FSActLayer, nil);
END;
RUN(Example);

VectorScript Declaration:

FUNCTION   CreateGroupOutline

( objectName:HANDLE ) :HANDLE ;

Python:

def  vs.CreateGroupOutline(objectName):

   return HANDLE

Description:

Returns a handle to the polygon which is the outline of a group.

説明

グループの外郭に相当する多角形のハンドルを返します。

VectorScript Declaration:

FUNCTION   DefineCustomObj

(   pluginName :STRING;     prefWhen :INTEGER ) :HANDLE ;

Python:

def  vs.DefineCustomObj(pluginName, prefWhen):

   return HANDLE

Description:

Calls GS_DefineCustomObject for a passed plugin name and preference.

説明

与えられたプラグイン名、設定に対して GS_DefineCustomObject を呼ぶ。

VectorScript Declaration:

PROCEDURE   EnableParameter

(   inPlugin :HANDLE;     inParameterName :STRING;     inSetEnabled :BOOLEAN ) ;

Python:

def  vs.EnableParameter(inPlugin, inParameterName, inSetEnabled):

   return None

Description:

For plug-in objects, this procedure sets whether or not the specified parameter is enabled on the Object Info Palette. This routine is used inside plug-in object regeneration scripts to set their parameter enable state. This state is an object instance property.

説明

プラグインのパラメータに連動している編集可能なアイテムの動作を設定します。

Parameters:

inPlugin	Handle to the currently executing plug-in object.	プラグインのハンドル
inParameterName	Name of parameter, as it appears in the plug-in editor's parameter list.	パラメータの名前
inSetEnabled	Enabling flag.	動作の設定（TRUE：可能／FALSE：不可能）

VectorScript Declaration:

PROCEDURE   FlipHybMatrixObj

(   ioHybMatObj :HANDLE;     inFlipSpecifier :INTEGER ) ;

Python:

def  vs.FlipHybMatrixObj(ioHybMatObj, inFlipSpecifier):

   return None

Description:

inFlipSpecifier = 0 for flipH inFlipSpecifier = 1 for FlipV

説明

inFlipSpecifier = 0 ならば flipH、 inFlipSpecifier = 1 ならば FlipV

VectorScript Declaration:

FUNCTION   Generate2DFrom3DComp

(   objectHandle :HANDLE;     component :INTEGER;     renderMode :INTEGER;     levelOfDetail :INTEGER ) :BOOLEAN ;

Python:

def  vs.Generate2DFrom3DComp(objectHandle, component, renderMode, levelOfDetail):

   return BOOLEAN

Description:

Generates the specified 2D component of a symbol definition or plug-in object from the 3D component.
The resulting graphics will be similar to converting the 3D component to lines from a view corresponding to the 2D component view.
3D objects visible in the specified detail level will be used to generate the 2D component.

Table - 2D Components

2D Component	Constant
Not Set	0
Top	1
Bottom	2
Top and Bottom Cut	3
Front	4
Back	5
Front and Back Cut	6
Left	7
Right	8
Left and Right Cut	9

Table - Available Render Modes

Render Mode	Constant
Wireframe	0
Hidden Line	6
Dashed Hidden Line	7

Table - Available Render Modes

Table - Detail Levels Detail Level Constant Low 1 Medium 2 High 4 All 7 説明 指定したシンボル定義、またはプラグインオブジェクトの2Dコンポーネントを3Dコンポーネントから生成します。 作成されるグラフィックは、2Dコンポーネントビューに対応するビューから、3Dコンポーネントを線分に変換したのと似たような感じになります。 指定した詳細レベルで表示される3Dオブジェクトは、2Dコンポーネントの生成に使用されます。 Table - 2D Components 2D Component Constant Not Set 0 Top 1 Bottom 2 Top and Bottom Cut 3 Front 4 Back 5 Front and Back Cut 6 Left 7 Right 8 Left and Right Cut 9 Table - Available Render Modes Render Mode Constant Wireframe 0 Hidden Line 6 Dashed Hidden Line 7 Table - Available Render Modes    return BOOLEAN Table - Detail Levels Detail Level Constant Low 1 Medium 2 High 4 All 7 Parameters: objectHandle Handle of a symbol or plug-in object. シンボル定義またはプラグインオブジェクトのハンドル component 2D component. コンポーネント renderMode Render mode. レンダリングモード levelOfDetail Detail level. 3D objects visible in this detail level will be used to generate 2D component. 詳細レベル Result: TRUE if the operation succeeded. 返り値 成功するとTRUEを返します。 See Also: Get2DComponentGroup   Set2DComponentGroup     Get2DCompByStyle Objects - Custom  Vectorworks 2020 VectorScript Declaration: FUNCTION   Get2DCompByStyle ( hObject:HANDLE ) :BOOLEAN ; Python: def  vs.Get2DCompByStyle(hObject):

VectorScript Declaration:

PROCEDURE   Get2DCompLocation

(   hObject :HANDLE;     component :INTEGER;   VAR  onBoundsCube :BOOLEAN;   VAR  offset :REAL ) ;

Python:

def  vs.Get2DCompLocation(hObject, component):

   return (onBoundsCube, offset)

VectorScript Declaration:

FUNCTION   Get2DComponentGroup

(   objectHandle :HANDLE;     component :INTEGER ) :HANDLE ;

Python:

def  vs.Get2DComponentGroup(objectHandle, component):

   return HANDLE

Description:

Gets the specified 2D component group of a symbol definition or plug-in object or NULL if the group does not exist.

Table - 2D Components

2D Component	Constant
Not Set	0
Top	1
Bottom	2
Top and Bottom Cut	3
Front	4
Back	5
Front and Back Cut	6
Left	7
Right	8
Left and Right Cut	9

説明

指定したシンボル定義、またはプラグインオブジェクトの2Dコンポーネントグループを返します。存在しない場合はNULLを返します。 Table - 2D Components

2D Component	Constant
Not Set	0
Top	1
Bottom	2
Top and Bottom Cut	3
Front	4
Back	5
Front and Back Cut	6
Left	7
Right	8
Left and Right Cut	9
Top/Plan	10

Parameters:

objectHandle	Handle to the object.	シンボル定義またはプラグインオブジェクトのハンドル
component	2D component.	2Dコンポーネント

Result:

Returns a HANDLE to the specified 2D component group.

返り値

2Dコンポーネントグループのハンドルを返します。

See Also:

Set2DComponentGroup   SetTopPlan2DComp   GetTopPlan2DComp  

VectorScript Declaration:

FUNCTION   GetCatalogItem

( hObj:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetCatalogItem(hObj):

   return BOOLEAN

Description:

Show the plug-in item catalog dialog to choose an item defined in the catalog. The object will be updated with all parameters defiend in the catalog.

説明

プラグインのカタログダイアログボックスを開いて、カタログの製品を選択します。オブジェクトは、選択したカタログのパラメータで更新されます。

Parameters:

hObj

Handle to plug-in object.

プラグインオブジェクトのハンドル

Result:

TRUE if a catalog item is selected.

返り値

カタログの製品が選択された場合はTRUEを返します。

VectorScript Declaration:

FUNCTION   GetCatalogPath

(   inhObject :HANDLE;   VAR  outFolderSpec :INTEGER;   VAR  outRelativePath :STRING ) :BOOLEAN ;

Python:

def  vs.GetCatalogPath(inhObject):

   return (BOOLEAN, outFolderSpec, outRelativePath)

Description:

Get the path to catalog files for a plug-in object.

説明

プラグインオブジェクトのカタログへの相対パスを返します。

Parameters:

inhObject	Handle of parametric object.	プラグインオヴジェクトのハンドル
outFolderSpec	Returns the Folder Specificer of the catalogs.	カタログフォルダの番号を返します。
outRelativePath	Returns the relative path to the folder specficier. May be empty.	カタログフォルダへの相対パスを返します。

Result:

TRUE of the object supports catalogs.
FALSE if the object does not support catalogs.

返り値

オブジェクトがカタログをサポートしている場合はTRUEを返します。
オブジェクトがカタログをサポートしていない場合はFALSEを返します。

VectorScript Declaration:

FUNCTION   GetClassByStyle

( hObject:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetClassByStyle(hObject):

   return BOOLEAN

説明

指定したシンボル定義、プラグインオブジェクトのスタイル、またはプラグインオブジェクトのクラスが、スタイルによるクラスかどうかを返します。

VectorScript Declaration:

FUNCTION   GetCustomFeedback

(   ParametricHandle :HANDLE;   VAR  FeedbackGroup :HANDLE ) :Boolean ;

Python:

def  vs.GetCustomFeedback(ParametricHandle):

   return (Boolean, FeedbackGroup)

Description:

Gets the group of objects attached to a parametric used only for display on screen, this group will not export or print.

説明

画面上の表示にのみ使用されているパラメトリック図形に連結している図形グループを返します。このグループは取り出しやプリントはされません。

Parameters:

ParametricHandle	The parametric object to which the feedback group was added.	パラメトリック図形のハンドル
FeedbackGroup	The feedback group that was attached to the Parametric Object.	連結している図形グループのハンドル

Result:

True if a feedback group was attached to the parametric, false if the object was not a parametric or a feedback group was not attached.

返り値

パラメトリック図形に連結している場合TRUEを返します。

VectorScript Declaration:

FUNCTION   GetCustomObjectChoice

(   objectName :STRING;     parameterName :STRING;     choiceIndex :INTEGER ) :STRING ;

Python:

def  vs.GetCustomObjectChoice(objectName, parameterName, choiceIndex):

   return STRING

Description:

Function GetCustomObjectChoice returns a choice string of the specified plug-in object popup menu or radio group parameter. These parameters are displayed in the Object Info palette or the plug-in objects' creation dialog.

The string passed into the parameter name argument should use the parameter constant syntax, not the actual parameter name. The string should have the prefix character 'P', and should have all spaces replaced with underscore characters. For example, a parameter Jamb Depth would have a constant declared as PJAMB_DEPTH and therefore the parameter name argument to this function should be the string 'PJAMB_DEPTH'.

The choiceIndex parameter should be passed an integer between 1 and the number of choices, which can be determined by calling the NumCustomObjectChoices function.

説明

プラグイン、パラメータの名前、メニュー項目番号からメニュー項目の名前を返します。

Parameters:

objectName	Name of the plugin object.	プラグインオブジェクトの名前
parameterName	String indicating which parameter.	パラメータの名前
choiceIndex	Index of desired choice.	メニュー項目番号

Result:

Returns associated string of specified choice list item.

返り値

項目名を返します。

Example:

theChoice := GetCustomObjectChoice(objectName, 'PDINNER_MENU', 1);

See Also:

NumCustomObjectChoices  

VectorScript Declaration:

FUNCTION   GetCustomObjectColor

(   objectHand :HANDLE;     inTagID :INTEGER;   VAR  outColorIndex :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetCustomObjectColor(objectHand, inTagID):

   return (BOOLEAN, outColorIndex)

Description:

Get an auxilary color index stored in'objectHand' previously with SetCustomObjectColor . Aplication will preserve the color mapped to inTagID.

説明

SetCustomObjectColorで設定され「objectHand」に設定されている色を返します。色はinTagIDに保持されます。

Parameters:

objectHand

Handle to object.

図形のハンドル

Result:

Returns TRUE if the operation was successful.

返り値

設定できた場合はTRUEを返します。

Example:

PROCEDURE Example;
VAR
	objName :STRING;
	objHand, recHand, wallHand :HANDLE;
	colorIndexBefore, colorIndexAfter :INTEGER;
	boo :BOOLEAN;
BEGIN
	IF GetCustomObjectInfo(objName, objHand, recHand, wallHand) THEN BEGIN
		RGBToColorIndex(pRed, pGreen, pBlue, colorIndexBefore);
		Rect(0, 0, 1, 1);
		SetFillBack(LNewObj, colorIndexBefore);
		IF SetCustomObjectColor(objHand, 1, colorIndexBefore) THEN BEGIN
			boo := GetCustomObjectColor(objHand, 1, colorIndexAfter);
			AlrtDialog(Concat('before: ', colorIndexBefore, Chr(13), 'after: ', colorIndexAfter));
		END;
	END;
END;
RUN(Example);

See Also:

SetCustomObjectColor  

VectorScript Declaration:

FUNCTION   GetCustomObjectInfo

( VAR  objectName :STRING;   VAR  objectHand :HANDLE;   VAR  recordHand :HANDLE;   VAR  wallHand :HANDLE ) :BOOLEAN ;

Python:

def  vs.GetCustomObjectInfo():

   return (BOOLEAN, objectName, objectHand, recordHand, wallHand)

Description:

Function GetCustomObjectInfo is used within plug-in object scripts to determine information about the object. Only returns false if the object is corrupt.

説明

プラグインオブジェクトのソースコード内で利用され、そのプラグインオブジェクトの情報を返します。オブジェクトが壊れている場合にのみ、FALSEを返します。

Parameters:

objectName	Returns the name of the object.	プラグインオブジェクトの名前
objectHand	Returns a handle to the plugin object in the drawing.	プラグインオブジェクトのハンドル
recordHand	Returns a handle to the record containing current parameter values.	レコードのハンドル
wallHand	Returns a handle to a wall, (if this object is in a wall).	壁のハンドル（オブジェクトが壁の中にある場合）

See Also:

IsNewCustomObject  

VectorScript Declaration:

FUNCTION   GetCustomObjectPath

( objectHand:HANDLE ) :HANDLE ;

Python:

def  vs.GetCustomObjectPath(objectHand):

   return HANDLE

Description:

Returns a handle to the path polygon of a path custom object.

説明

ハンドルで指定したプラグインオブジェクトのパス図形のハンドルを返します。

Parameters:

objectHand

Handle to object.

プラグインオブジェクトのハンドル

Result:

Returns a HANDLE to the path polygon.

返り値

パス図形（曲線 or NURBS）のハンドルを返します。

See Also:

SetCustomObjectPath  

VectorScript Declaration:

FUNCTION   GetCustomObjectProfileGroup

( objectHand:HANDLE ) :HANDLE ;

Python:

def  vs.GetCustomObjectProfileGroup(objectHand):

   return HANDLE

Description:

Returns a handle to the profile group of a path custom object.

A path object has two "containers" for storing subordinate objects: the path, and the profile. As an example, if a path object is going to do an extrude along path, it will store the path in the path container, and the shape to be extruded in the profile container. The code within the object will then supply the handles to the path and the profile to the CreateExtrudeAlongPath call.

説明

ハンドルで指定したプラグインオブジェクトの輪郭図形のハンドルを返します。

Parameters:

objectHand

Handle to path custom object.

プラグインオブジェクトのハンドル

Result:

Returns a HANDLE to the profile group.

返り値

輪郭図形のハンドルを返します。

See Also:

SetCustomObjectProfileGroup  

VectorScript Declaration:

FUNCTION   GetCustomObjectSelectionGroup

( objectHand:HANDLE ) :HANDLE ;

Python:

def  vs.GetCustomObjectSelectionGroup(objectHand):

   return HANDLE

Description:

Access the handle to selection group. This group contains geometry that defines the selection and pre-selection indication of this object.

説明

グループのハンドルを返します。このグループには、パラメータで指定したプラグインオブジェクトが選択された際に、強調表示する形状が含まれています。

Parameters:

objectHand

Handle to custom object.

プラグインオブジェクトのハンドル

Result:

Returns a HANDLE to the selection group.

返り値

選択時に強調表示するグループのハンドルを返します。

VectorScript Declaration:

FUNCTION   GetCustomObjectWallHoleGroup

( objectHand:HANDLE ) :HANDLE ;

Python:

def  vs.GetCustomObjectWallHoleGroup(objectHand):

   return HANDLE

Description:

Access the handle to wall hole group. This group contains geometry that defines the opening that will be cut into the wall for this parametric object.

説明

グループのハンドルを返します。このグループには、パラメータで指定したプラグインオブジェクトが壁に挿入された際に、壁に作られる開口部を定義するする形状が含まれています。

Parameters:

objectHand

Handle to custom object.

プラグインオブジェクトのハンドル

Result:

Returns a HANDLE to the wall hole group.

返り値

開口部グループのハンドルを返します。

VectorScript Declaration:

FUNCTION   GetCustomObjSecPath

( objectHand:HANDLE ) :HANDLE ;

Python:

def  vs.GetCustomObjSecPath(objectHand):

   return HANDLE

Description:

Returns a handle to the second path polygon of a path custom object.

説明

パスカスタムオブジェクトの2番目のパスポリゴンへのハンドルを返します。

Parameters:

objectHand

Handle to object.

プラグインオブジェクトのハンドル

Result:

Returns a HANDLE to the second path polygon.

返り値

2つ目のパスポリゴンへのハンドルを返します。

See Also:

GetCustomObjectPath  

VectorScript Declaration:

FUNCTION   GetDisplayWith2DComp

(   objectHandle :HANDLE;     component :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetDisplayWith2DComp(objectHandle, component):

   return BOOLEAN

Description:

Gets whether a 3D object in a symbol definition or plug-in object is shown when the specified 2D component is shown.

Table - 2D Components

2D Component	Constant
Not Set	0
Top	1
Bottom	2
Top and Bottom Cut	3
Front	4
Back	5
Front and Back Cut	6
Left	7
Right	8
Left and Right Cut	9

説明

指定したシンボル定義またはプラグインオブジェクトの3Dオブジェクトが、指定した2Dコンポーネントの表示時に表示されているかどうかを返します。

Table - 2D Components

2D Component	Constant
Not Set	0
Top	1
Bottom	2
Top and Bottom Cut	3
Front	4
Back	5
Front and Back Cut	6
Left	7
Right	8
Left and Right Cut	9

Parameters:

objectHandle	3D object handle.	3Dオブジェクトのハンドル
component	2D component.	2Dコンポーネント

Result:

Returns whether a 3D object in a symbol definition or plug-in object is shown when the specified 2D component is shown.

返り値

指定した2Dコンポーネントの表示時に、シンボル定義またはプラグインオブジェクト内の3Dオブジェクトが表示されているかどうかを返します。

VectorScript Declaration:

PROCEDURE   GetExWllClsrFrmSt

(   hObject :HANDLE;   VAR  left :BOOLEAN;   VAR  right :BOOLEAN;   VAR  top :BOOLEAN;   VAR  bottom :BOOLEAN ) ;

Python:

def  vs.GetExWllClsrFrmSt(hObject):

   return (left, right, top, bottom)

Description:

Gets the exclude wall closure from settings of a symbol definition, plug-in object style, or plug-in object.

説明

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの設定から、「壁との取り合い設定を除外」設定を取得します。

Parameters:

hObject	The symbol definition, plug-in object style, or plug-in object.	シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクト
left	Returns the exclude wall closure from left setting.	「壁との取り合い設定を除外」設定の左側の設定を返します。
right	Returns the exclude wall closure from right setting.	「壁との取り合い設定を除外」設定の右側の設定を返します。
top	Returns the exclude wall closure from top setting.	「壁との取り合い設定を除外」設定の上側の設定を返します。
bottom	Returns the exclude wall closure from bottom setting.	「壁との取り合い設定を除外」設定の下側の設定を返します。

See Also:

SetExWllClsrFrmSt  

VectorScript Declaration:

FUNCTION   GetHorizSecCPByStyle

( hObject:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetHorizSecCPByStyle(hObject):

   return BOOLEAN

VectorScript Declaration:

FUNCTION   GetHorizSecCutPlane

( hObject:HANDLE ) :INTEGER ;

Python:

def  vs.GetHorizSecCutPlane(hObject):

   return INTEGER

VectorScript Declaration:

FUNCTION   GetLocalizedPluginChoice

(   inPluginName :STRING;     inParameterName :STRING;     inChoiceIndex :INTEGER;   VAR  outChoice :STRING ) :BOOLEAN ;

Python:

def  vs.GetLocalizedPluginChoice(inPluginName, inParameterName, inChoiceIndex):

   return (BOOLEAN, outChoice)

Description:

Returns true with outChoice as specified by inPluginName, inParameterName and inChoiceIndex. Each of the input names are universal names.

説明

プラグイン、パラメータの名前、メニュー項目番号からローカライズ後の名前を返します。
プラグイン、パラメータの名前にはユニバーサルな名前を入れます。

Parameters:

inPluginName	The universal name of the plug-in.	プラグインの名前
inParameterName	The universal name of the parameter.	パラメータの名前
inChoiceIndex	The index of the requested choice. ( range is 1 to n)	メニュー項目番号（1からnの範囲）
outChoice	The requested choice string.	ローカライズ後の名前

Result:

Returns true if the function call succeeded.

返り値

TRUE：関数が正しく動作しました。
FALSE：関数が正しく動作しませんでした。

See Also:

GetLocalizedPluginName  

VectorScript Declaration:

FUNCTION   GetLocalizedPluginName

(   inPluginName :STRING;   VAR  outName :STRING ) :BOOLEAN ;

Python:

def  vs.GetLocalizedPluginName(inPluginName):

   return (BOOLEAN, outName)

Description:

Get the localized name of a plug-in given its universal name.

When Vectorworks plug-ins are localized by distributors in other countries, their names are translated to the appropriate language. The plug-in file stores both the original universal name and this translated localized name. The translated name is displayed by the Vectorworks user interface instead of the original name. If a script needs to display the name of a plug-in in a dialog or message then it should call this function to determine the localized name. (Note that scripts will use the universal name to specify a plug-in when the name is not being displayed to the user.)

If the plug-in has not been localized, then this function will return the universal name.

説明

プラグインの名前からローカライズ後の名前を返します。

Parameters:

inPluginName	Universal name of the plug-in.	プラグインの名前
outName	The localized name of the plug-in	ローカライズ後の名前

Result:

Returns true if the specified plug-in exists, and false if it is not found.

返り値

TRUE：プラグインが存在しました。
FALSE：プラグインが存在しませんでした。

Example:

PROCEDURE Example;
TYPE
	plugin = STRUCTURE
		universalName :STRING;
		localizedName :STRING;
		params :ARRAY[1..99,1..2] OF STRING;
		popups :ARRAY[1..99,1..99] OF STRING;
	END;
VAR
	plugins :ARRAY[1..99] OF plugin;
	cnt1, cnt2, cnt3, pluginCnt :INTEGER;
	str1, str2, str3, str4 :STRING;
	boo :BOOLEAN;
	int1, int2 :INTEGER;
	
PROCEDURE GetInfo(h :HANDLE);
VAR
	recHand :HANDLE;
	recName :STRING;
BEGIN
	recHand := GetRecord(h, NumRecords(h));
	recName := GetName(recHand);
	FOR cnt1 := 1 TO pluginCnt DO 
		IF recName = plugins[cnt1].universalName 
			THEN cnt1 := pluginCnt + 2;
	IF cnt1 < pluginCnt + 2 THEN BEGIN
		boo := GetLocalizedPluginName(recName, str2);
		pluginCnt := pluginCnt + 1;
		plugins[pluginCnt].universalName := recName;
		plugins[pluginCnt].localizedName := str2;
		FOR cnt2 := 1 TO NumFields(recHand) DO BEGIN
			str1 := GetFldName(recHand, cnt2);
			int1 := GetFldType(recHand, cnt2);
			boo := GetLocalizedPluginParameter(recName, str1, str2);
			plugins[pluginCnt].params[cnt2, 1] := str1;
			plugins[pluginCnt].params[cnt2, 2] := str2;
			IF int1 = 8 THEN BEGIN
				FOR cnt3 := 1 TO NumCustomObjectChoices(recName, str1) DO BEGIN
					str3 := GetCustomObjectChoice(recName, str1, cnt3);
					boo := GetPluginChoiceIndex(recName, str1, str3, int2);
			  		boo := GetLocalizedPluginChoice(recName, str1, int2, str4);
			  		plugins[pluginCnt].popups[cnt2, cnt3] := Concat(str3, Chr(9), str4);
				END;
			END;
		END;
	END;
END;

BEGIN
	pluginCnt := 0;
	ForEachObject(GetInfo, (T=86));
	FOR cnt1 := 1 TO pluginCnt DO BEGIN
		WriteLn(plugins[cnt1].universalName, Chr(9), plugins[cnt1].localizedName);
		cnt2 := 1;
		WHILE plugins[cnt1].params[cnt2, 1] <> '' DO BEGIN
			WriteLn('    ', plugins[cnt1].params[cnt2, 1], Chr(9), plugins[cnt1].params[cnt2, 2]);
			cnt3 := 1;
			WHILE plugins[cnt1].popups[cnt2, cnt3] <> '' DO BEGIN
				WriteLn('        ', plugins[cnt1].popups[cnt2, cnt3]);
				cnt3 := cnt3 + 1;
			END;
			cnt2 := cnt2 + 1;
		END;
	END;
END;
RUN(Example);

See Also:

GetLocalizedPluginParameter   GetLocalizedPluginChoice  

VectorScript Declaration:

FUNCTION   GetLocalizedPluginParameter

(   inPluginName :STRING;     inParameterName :STRING;   VAR  outParameter :STRING ) :BOOLEAN ;

Python:

def  vs.GetLocalizedPluginParameter(inPluginName, inParameterName):

   return (BOOLEAN, outParameter)

Description:

Get the localized name of a plug-in parameter.

When Vectorworks plug-ins are localized by distributors in other countries, their parameter names are translated to the appropriate language. The plug-in file stores both the original universal name and this translated localized name for each parameter. The translated name is displayed by the Vectorworks user interface instead of the original name. If a script needs to display the name of a plug-in parameter in a dialog or message then it should call this function to determine the localized name. (Note that scripts will use the universal name to specify a plug-in parameter when the name is not being displayed to the user.)

If the plug-in has not been localized, then this function will return the universal name of the parameter.

説明

プラグイン、パラメータの名前からローカライズ後の名前を返します。
プラグイン、パラメータの名前にはユニバーサルな名前を入れます。

Parameters:

inPluginName	Universal name of the plug-in.	プラグインの名前
inParameterName	Universal name of the parameter.	パラメータの名前
outParameter	Localized name of the parameter.	ローカライズ後の名前

Result:

Returns true if the specified plug-in exists, and false if it is not found.

返り値

TRUE：プラグインが存在しました。
FALSE：プラグインが存在しませんでした。

See Also:

GetLocalizedPluginName  

VectorScript Declaration:

FUNCTION   GetMirrorEmpty2DComp

( objectHandle:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetMirrorEmpty2DComp(objectHandle):

   return BOOLEAN

Description:

Gets whether the opposite view graphics are mirrored for empty 2D components of a symbol definition or plug-in object.

説明

指定したシンボル定義、またはプラグインオブジェクトの存在しない2Dコンポーネントに、反対側のビューのグラフィックがミラー複製されているかどうかを返します。。

Parameters:

objectHandle

Handle of a symbol or plug-in object.

シンボル定義またはプラグインオブジェクトのハンドル

Result:

TRUE if the opposite view graphics are mirrored for empty 2D components of a symbol definition or plug-in object.

返り値

シンボル定義、またはプラグインオブジェクトの存在しない2Dコンポーネントに、反対側のビューのグラフィックがミラー複製されている場合はTRUEを返します。

See Also:

SetMirrorEmpty2DComp   Get2DComponentGroup   Set2DComponentGroup  

VectorScript Declaration:

FUNCTION   GetMrEm2DCompByStyle

( hObject:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetMrEm2DCompByStyle(hObject):

   return BOOLEAN

VectorScript Declaration:

FUNCTION   GetParamStyleType

(   hStyle :HANDLE;     paramName :STRING ) :INTEGER ;

Python:

def  vs.GetParamStyleType(hStyle, paramName):

   return INTEGER

Description:

Returns the style type (by instance or by style) for a parameter.

説明

プラグインスタイル定義から指定したパラメータがスタイルの値を使用するかインスタンスの値を使用するかを返します。

Parameters:

hStyle	Handle to a symbol containing a plug-in style.	プラグインスタイルのハンドル
paramName	Universal name of a parameter to check for style type.	パラメータの名前

Result:

0 = Parametrer is an instance parameter
1 = Parameter is a style parameter.

If the object in unstyled or the parameter name if not found 0 will be returned and should be treated as an instance parameter.

返り値

0 = インスタンスの値を使用します
1 = スタイルの値を使用します

スタイルを使用していないかパラメータ名が存在しない場合は0を返します。

VectorScript Declaration:

FUNCTION   GetPartDataID

( objectHandle:HANDLE ) :LONGINT ;

Python:

def  vs.GetPartDataID(objectHandle):

   return LONGINT

Description:

Return the numeric value assigned to this part instance represented by the specified sub-object.
The sub-object must be an object that was tagged as a part.

説明

指定したオブジェクトで表されているパーツインスタンスに割り当てられている数値を返します。

Parameters:

objectHandle

The sub-object handle.

図形のハンドル

Result:

The numeric value assigned to this part instance.

返り値

このパーツインスタンスに割り当てられた整数値を返します。

VectorScript Declaration:

FUNCTION   GetPartInstanceName

( objectHandle:HANDLE ) :STRING ;

Python:

def  vs.GetPartInstanceName(objectHandle):

   return STRING

Description:

Return the unique name assigned to this part instance represented by the specified sub-object.
The sub-object must be an object that was tagged as a part.

説明

指定したオブジェクトで表されているパーツインスタンスに割り当てられている固有の名前を返します。

Parameters:

objectHandle

The sub-object handle.

図形のハンドル

Result:

The unique name assigned to this part instance.

返り値

このパーツインスタンスに割り当てられた固有の名前

VectorScript Declaration:

FUNCTION   GetPartTypeInfo

(   objectHandle :HANDLE;   VAR  partTypeName :STRING;   VAR  dataID :LONGINT;   VAR  uniqueInstanceName :STRING ) :BOOLEAN ;

Python:

def  vs.GetPartTypeInfo(objectHandle):

   return (BOOLEAN, partTypeName, dataID, uniqueInstanceName)

Description:

Get all part information for the specified sub-object. The sub-object must be an object that was tagged as a part.

説明

指定したオブジェクトのすべてのパーツ情報を取得します。

Parameters:

objectHandle	The sub-object handle.	図形のハンドル
partTypeName	The name of the part type.	パーツタイプの名前
dataID	The numeric value assigned to this part instance	このパーツインスタンスに割り当てられた整数値
uniqueInstanceName	The unique name assigned to this part instance.	このパーツインスタンスに割り当てられた固有の名前。

Result:

Return TRUE if the specified object is a part and the part information was retrieved successfully.

返り値

指定されたオブジェクトがパーツであり、パーツ情報が正常に取得された場合はTRUEを返します。

See Also:

TagSubObjectAsPart   IsObjectTaggedAsPart   GetPartTypeName  

VectorScript Declaration:

FUNCTION   GetPartTypeName

( objectHandle:HANDLE ) :STRING ;

Python:

def  vs.GetPartTypeName(objectHandle):

   return STRING

Description:

Return the part type for the specified sub-object.
The sub-object must be an object that was tagged as a part.

説明

指定したオブジェクトのパーツタイプを返します。
オブジェクトは、パーツとしてタグ付けされたオブジェクトである必要があります。

Parameters:

objectHandle

The sub-object handle.

図形のハンドル

Result:

The part type name for the specified sub-object. The sub-object must be an object that was tagged as a part.

返り値

指定されたオブジェクトのパーツタイプ名。 オブジェクトは、パーツとしてタグ付けされたオブジェクトである必要があります。

See Also:

TagSubObjectAsPart  

VectorScript Declaration:

FUNCTION   GetPluginChoiceIndex

(   inPluginName :STRING;     inParameterName :STRING;     inChoiceName :STRING;   VAR  outIndex :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetPluginChoiceIndex(inPluginName, inParameterName, inChoiceName):

   return (BOOLEAN, outIndex)

Description:

Returns true with outIndex as specified by inPluginNameand inParameterName. Each of the input names are universal names.

説明

プラグイン、パラメータ、メニュー項目の名前からメニュー項目番号を返します。
プラグイン、パラメータの名前にはユニバーサルな名前を入れます。

Parameters:

inPluginName	The universal name of the plug-in.	プラグインの名前
inParameterName	The universal name of the parameter.	パラメータの名前
inChoiceName	The universal name of the choice.	メニュー項目の名前
outIndex	The index of the requested choice. ( range is 1 to n)	メニュー項目番号（1からnの範囲）

Result:

Returns true if the function succeeded.

返り値

TRUE：関数が正しく動作しました。
FALSE：関数が正しく動作しませんでした。

VectorScript Declaration:

FUNCTION   GetPluginInfo

( VAR  pluginName :STRING;   VAR  recordHand :HANDLE ) :BOOLEAN ;

Python:

def  vs.GetPluginInfo():

   return (BOOLEAN, pluginName, recordHand)

Description:

Returns the name and attached parameter record of the currently executing plug-in. Use with menu command or tool item plug-ins.

説明

実行されているプラグインの名前とレコードのハンドルを返します。

Parameters:

pluginName	Name of plug-in.	プラグインの名前
recordHand	Handle to parameter record of plug-in.	レコードのハンドル

VectorScript Declaration:

FUNCTION   GetPluginString

( stringIndex:INTEGER ) :DYNARRAY[] of CHAR ;

Python:

def  vs.GetPluginString(stringIndex):

   return DYNARRAY of CHAR

Description:

Returns the string specified by stringIndex. The strings are created using the "Strings" button in the plug-in editor.

説明

索引番号で指定された文字列を返します。文字列は「プラグインコマンド編集」ダイアログの「ストリング...」ボタンをクリックすると作成できます。

Parameters:

stringIndex

The index of the string as represented in the plug-in editor.

索引番号

Result:

The requested string.

返り値

文字列を返します。

VectorScript Declaration:

FUNCTION   GetPluginStyle

( hObject:HANDLE ) :STRING ;

Python:

def  vs.GetPluginStyle(hObject):

   return STRING

Description:

Get the name of the plug-in style for an object.

説明

オブジェクトのプラグインスタイルの名前を取得します。

Parameters:

hObject

Handle to a plug-in object

プラグインオブジェクトのハンドル

Result:

Returns the name of the plug-in style associated with an object.

返り値

オブジェクトのプラグインスタイルの名前を返します。

VectorScript Declaration:

FUNCTION   GetPluginStyleSymbol

(   hObject :HANDLE;   VAR  hSymDef :HANDLE ) :BOOLEAN ;

Python:

def  vs.GetPluginStyleSymbol(hObject, hSymDef):

   return (BOOLEAN, hSymDef)

Description:

Retrieves the handled to a symbol that defines the plug-in style for a given plug-in object.

説明

オブジェクトに割り当てられたプラグインスタイルを定義しているシンボルのハンドルを返します。

Parameters:

hObject	Handle to a plug-in object.	プラグインオブジェクトのハンドル
hSymDef	Hanlde to a symbol definition that contrains the plug-in style associated with hObject.	シンボル定義のハンドル

Result:

TRUE if the object is styled.
FALSE if the object is uynstyled.

返り値

オブジェクトにスタイルが割り当てられている場合TRUEを返します。
オブジェクトにスタイルが割り当てられていない場合FALSEを返します。

VectorScript Declaration:

FUNCTION   GetTopPlan2DComp

( objectHandle:HANDLE ) :INTEGER ;

Python:

def  vs.GetTopPlan2DComp(objectHandle):

   return INTEGER

Description:

Gets the 2D component that is shown in Top/Plan view for a symbol definition or plug-in object

Table = Components

Component	Constant
Top	0
Top and Bottom Cut	1

説明

指定したシンボル定義、またはプラグインオブジェクトの、2D/平面（上面）ビューで表示される2Dコンポーネントを返します。

Table = Components

Component	Constant
Top	0
Top and Bottom Cut	1

Parameters:

objectHandle

Handle to the object.

オブジェクトのハンドル

Result:

Returns the 2D component that is shown in Top/Plan view for a symbol definition or plug-in object.

返り値

シンボル定義、またはプラグインオブジェクトの、2D/平面（上面）ビューで表示される2Dコンポーネントを返します。

See Also:

SetTopPlan2DComp   Get2DComponentGroup   Set2DComponentGroup  

VectorScript Declaration:

FUNCTION   GetTpPl2DCompByStyle

( hObject:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetTpPl2DCompByStyle(hObject):

   return BOOLEAN

VectorScript Declaration:

FUNCTION   GetUseWallClosure

( hObject:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetUseWallClosure(hObject):

   return BOOLEAN

Description:

Gets the use wall closure setting of a symbol definition, plug-in object style, or plug-in object.

説明

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの壁との取り合いの設定を取得します。

Parameters:

hObject

The symbol definition, plug-in object style, or plug-in object.

図形のハンドル

Result:

The use wall closure setting of the symbol definition, plug-in object style, or plug-in object.

返り値

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの壁との取り合い設定を使用します。

See Also:

SetUseWallClosure  

VectorScript Declaration:

FUNCTION   GetUseWllClsrByStyle

( hObject:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetUseWllClsrByStyle(hObject):

   return BOOLEAN

Description:

Gets whether the use wall closure setting of a symbol definition, plug-in object style, or plug-in object is by style.

説明

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの壁との取り合いの使用設定がスタイルによるものかどうかを取得します。

Parameters:

hObject

The symbol definition, plug-in object style, or plug-in object.

図形のハンドル

Result:

Whether the use wall closure setting of the symbol definition, plug-in object style, or plug-in object is by style.

返り値

シンボル定義、プラグインオブジェクトのスタイル、またはプラグインオブジェクトの壁との取り合いの設定を使用するかどうかは、スタイルごとです。

See Also:

SetUseWllClsrByStyle  

VectorScript Declaration:

FUNCTION   GetVertSecCPByStyle

( hObject:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetVertSecCPByStyle(hObject):

   return BOOLEAN

VectorScript Declaration:

FUNCTION   GetVertSecCutPlane

( hObject:HANDLE ) :INTEGER ;

Python:

def  vs.GetVertSecCutPlane(hObject):

   return INTEGER

VectorScript Declaration:

FUNCTION   GetWallClosureGroup

( hObjecct:HANDLE ) :HANDLE ;

Python:

def  vs.GetWallClosureGroup(hObjecct):

   return HANDLE

Description:

Returns the handle to the wall closure group of an object.

説明

オブジェクトの壁との取り合いグループのハンドルを返します。

Parameters:

hObjecct

Handlel to the object containing the wall closure group

壁のハンドル

Result:

The handle to an object's wall closure group. The handle will be NIL if no object is found.

返り値

壁との取り合いグループのハンドルを返します。オブジェクトが見つからない場合、ハンドルはNILになります。

See Also:

SetWallClosureGroup  

VectorScript Declaration:

FUNCTION   GetWallInsertLoc

( hObject:HANDLE ) :INTEGER ;

Python:

def  vs.GetWallInsertLoc(hObject):

   return INTEGER

Description:

Gets the wall insert location of a symbol definition, plug-in object style, or plug-in object.

説明

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの壁挿入位置を取得します。

Parameters:

hObject

The symbol definition, plug-in object style, or plug-in object.

オブジェクトのハンドル

Result:

The wall insert location of the symbol definition, plug-in object style, or plug-in object.

-1 - Insert on the nearest edge of the wall
0 - Insert on the center of the wall
1 - Insert on the left edge of the wall
2 - Insert on the right edge of the wall
3 - Insert on the center of the wall core component
4 - Insert on the left edge of the wall core component
5 - Insert on the right edge of the wall core component
6 - Insert on the wall insert location
7 - Insert on the wall closure insert location

返り値

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの壁挿入位置。

-1 - 壁の最も近い端に挿入します
0 - 壁の中央に挿入します
1 - 壁の左端に挿入します
2 - 壁の右端に挿入します
3 - 壁コアコンポーネントの中央に挿入します
4 - 壁コアコンポーネントの左端に挿入します
5 - 壁コアコンポーネントの右端に挿入します

See Also:

SetWallInsertLoc  

VectorScript Declaration:

FUNCTION   GetWallInsertLocOff

( hObject:HANDLE ) :REAL ;

Python:

def  vs.GetWallInsertLocOff(hObject):

   return REAL

Description:

Gets the wall insert location offset of a symbol definition, plug-in object style, or plug-in object.

説明

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの壁挿入位置オフセットを取得します。

Parameters:

hObject

The symbol definition, plug-in object style, or plug-in object.

オブジェクトのハンドル

Result:

The wall insert location offset of the symbol definition, plug-in object style, or plug-in object.

返り値

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの壁挿入位置オフセット。

See Also:

SetWallInsertLocOff  

VectorScript Declaration:

FUNCTION   GetWallInsLocByStyle

( hObject:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetWallInsLocByStyle(hObject):

   return BOOLEAN

Description:

Gets whether the wall insert location of a symbol definition, plug-in object style, or plug-in object is by style.

説明

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの壁挿入位置がスタイルによるものかどうかを取得します。

Parameters:

hObject

The symbol definition, plug-in object style, or plug-in object.

オブジェクトのハンドル

Result:

Whether the wall insert location of the symbol definition, plug-in object style, or plug-in object is by style.

返り値

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの壁挿入位置がスタイルによるかどうか。

See Also:

SetWallInsLocByStyle  

VectorScript Declaration:

FUNCTION   GetWallRecessGroup

( objectHand:HANDLE ) :HANDLE ;

Python:

def  vs.GetWallRecessGroup(objectHand):

   return HANDLE

Description:

Get the wall recess geometry group associated with the object.

説明

オブジェクトに紐付いている壁の窪みのジオメトリグループを返します。

Parameters:

objectHand

Object handle to get the geometry for.

ジオメトリを取得するオブジェクトのハンドル

Result:

The group containing the geometry that will be used for wall recess.

返り値

オブジェクトに紐付いている壁の窪みのジオメトリを含むグループ

VectorScript Declaration:

FUNCTION   GetWInsLocOffByStyle

( hObject:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetWInsLocOffByStyle(hObject):

   return BOOLEAN

Description:

Gets whether the wall insert location offset of a symbol definition, plug-in object style, or plug-in object is by style.

説明

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの壁挿入位置オフセットがスタイルによるものかどうかを取得します。

Parameters:

hObject

The symbol definition, plug-in object style, or plug-in object.

オブジェクトのハンドル

Result:

Whether the wall insert location offset of the symbol definition, plug-in object style, or plug-in object is by style.

返り値

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの壁挿入位置オフセットがスタイルによるものであるかどうか。.

See Also:

SetWInsLocOffByStyle  

VectorScript Declaration:

FUNCTION   GetWllHoleObjIgnClsr

( object:HANDLE ) :BOOLEAN ;

Python:

def  vs.GetWllHoleObjIgnClsr(object):

   return BOOLEAN

Description:

Gets whether an object in the 3D Wall Hole group of a plug-in object ignores wall closures.

説明

プラグインオブジェクトの3D壁穴グループ内のオブジェクトが壁との取り合いを無視するかどうかを取得します。

Parameters:

object

The object in the 3D Wall Hole group of a plug-in object

オブジェクトのハンドル

Result:

Whether the object in the 3D Wall Hole group of a plug-in object ignores wall closures.

返り値

プラグインオブジェクトの3D壁穴グループ内のオブジェクトが壁との取り合いを無視するかどうか。

See Also:

SetWllHoleObjIgnClsr  

VectorScript Declaration:

FUNCTION   GtExWllClsrFrmStBStl

( hObject:HANDLE ) :BOOLEAN ;

Python:

def  vs.GtExWllClsrFrmStBStl(hObject):

   return BOOLEAN

Description:

Gets whether the exclude wall closure from settings of a symbol definition, plug-in object style, or plug-in object are by style.

説明

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの設定の「壁との取り合い設定を除外」設定がスタイルによる設定であるかどうかを返します。

Parameters:

hObject

The symbol definition, plug-in object style, or plug-in object.

指定するシンボル定義、プラグインオブジェクトのスタイル、またはプラグインオブジェクト

Result:

Whether the exclude wall closure from settings of a symbol definition, plug-in object style, or plug-in object are by style.

返り値

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの設定の「壁との取り合い設定を除外」設定がスタイルによる設定であるかどうかを返します。

See Also:

StExWllClsrFrmStBStl  

VectorScript Declaration:

FUNCTION   HasPlugin

(   itemUniversalName :STRING;   VAR  PaletteName :STRING ) :BOOLEAN ;

Python:

def  vs.HasPlugin(itemUniversalName):

   return (BOOLEAN, PaletteName)

Description:

Returns whether tool item or menu command is in current workspace.

説明

ツールアイテムやメニューコマンドがアクティブな作業画面に存在している場合は、そのパレットやメニューの名前とTRUEを返します。
ツールアイテムやメニューコマンドの名前にはユニバーサルな名前を入力します。

Parameters:

itemUniversalName	Universal name of the plug-in	ツールアイテムやメニューコマンドの名前
PaletteName	If plug-in is a tool, and is found in the workspace, the name of the palette in which it is contained will be returned in this parameter	パレットの名前

Result:

Returns true if the plug-in is found in the workspace; false otherwise.

返り値

TRUE：アクティブな作業画面にプラグインがあります。
FALSE：アクティブな作業画面にプラグインがありません。

VectorScript Declaration:

FUNCTION   IsCatalogParameter

(   hObj :HANDLE;     paramName :STRING ) :BOOLEAN ;

Python:

def  vs.IsCatalogParameter(hObj, paramName):

   return BOOLEAN

Description:

Check if a parameter is defined in the catalog that has been associated with an object's plug-in style.

説明

ハンドルで指定したオブジェクトの指定したパラメータが、関連付けられているプラグインスタイルのカタログで定義しているものかどうかを返します。

Parameters:

hObj	Handle to plug-in object	プラグインオブジェクトのハンドル
paramName	Name of parameter to check	パラメータの名前

VectorScript Declaration:

FUNCTION   IsNewCustomObject

( objectName:STRING ) :BOOLEAN ;

Python:

def  vs.IsNewCustomObject(objectName):

   return BOOLEAN

Description:

Function IsNewCustomObject returns whether the specified plug-in object is a new object, indicating that the object is being regenerated for the first time.


New object status is useful in specifying initialization and setup data, as well as calling initialization specific subroutines. This function should only be called in plug-in objects.

説明

指定した名前のプラグインオブジェクトが最初に生成された場合はTRUEを返します。

Parameters:

objectName

Name of plugin object.

プラグインオブジェクトの名前

返り値

新しいオブジェクトの場合はTRUE

See Also:

GetCustomObjectInfo  

VectorScript Declaration:

FUNCTION   IsObjectTaggedAsPart

( objectHandle:HANDLE ) :BOOLEAN ;

Python:

def  vs.IsObjectTaggedAsPart(objectHandle):

   return BOOLEAN

Description:

Determine if the specified sub-object is tagged as a part.

説明

指定したオブジェクトがパーツとしてタグ付けされているかどうかを返します。

Parameters:

objectHandle

The sub-object handle.

オブジェクトのハンドル

Result:

Return TRUE if the specified sub-object is tagged as a part.

返り値

指定されたオブジェクトがパーツとしてタグ付けされている場合はTRUEを返します。

See Also:

TagSubObjectAsPart  

VectorScript Declaration:

FUNCTION   IsPluginFormat

( theFormat:HANDLE ) :BOOLEAN ;

Python:

def  vs.IsPluginFormat(theFormat):

   return BOOLEAN

Description:

Determines if the format node is used for the parameters of a plug-in object, plug-in tool or plug-in menu command.

説明

レコードフォーマットがプラグインオブジェクト、プラグインツール、プラグインメニューのパラメータに使われている／いないを返します。

Parameters:

theFormat

Handle to the format node in question.

レコードフォーマット

Result:

Returns true if format is used by a plug-in and false if it is a regular format that may have been created by the user.

返り値

TRUE：レコードフォーマットはプラグインに使われています。
FALSE：レコードフォーマットはユーザによって作成されています。

VectorScript Declaration:

FUNCTION   NumCustomObjectChoices

(   objectName :STRING;     parameterName :STRING ) :INTEGER ;

Python:

def  vs.NumCustomObjectChoices(objectName, parameterName):

   return INTEGER

Description:

Function NumCustomObjectChoices returns the number of choice strings for a specified popup menu or radio group parameter in a plug-in object.

The string passed into the parameter name argument should use the parameter constant syntax, not the actual parameter name. The string should have the prefix character 'P', and should have all spaces replaced with underscore characters. For example, a parameter Jamb Depth would have a constant declared as PJAMB_DEPTH and therefore the parameter name argument to this function should be the string 'PJAMB_DEPTH'.

説明

プラグイン、パラメータの名前からメニュー項目の数を返します。

Parameters:

objectName	Name of plugin object.	プラグインオブジェクトの名前
parameterName	String indicating which parameter	パラメータの名前

返り値

項目の数

Example:

maxChoices := NumCustomObjectChoices(objName, 'PDINNER_MENU');

See Also:

GetCustomObjectChoice  

VectorScript Declaration:

FUNCTION   RemovePartTag

( objectHandle:HANDLE ) :BOOLEAN ;

Python:

def  vs.RemovePartTag(objectHandle):

   return BOOLEAN

Description:

Remove the part tag and all part information from the specified sub-object.

説明

指定したオブジェクトからパーツのタグとすべてのパーツ情報を削除します。

Parameters:

objectHandle

The sub-object handle.

オブジェクトのハンドル

Result:

Return TRUE if all part tag data have been removed from the sub-object.

返り値

すべてのパーツタグデータがオブジェクトから削除されている場合はTRUEを返します。

VectorScript Declaration:

FUNCTION   RemovePIOStyleEdit

(   hObj :HANDLE;     keyName :STRING ) :BOOLEAN ;

Python:

def  vs.RemovePIOStyleEdit(hObj, keyName):

   return BOOLEAN

Description:

Removes an item from the edit style mapping list.

説明

ハンドルで指定したプラグインオブジェクト/プラグインスタイルの編集マッピングダイアログボックスから項目を削除します。

Parameters:

hObj	Handle to a plug-in object or plug-in style	プラグインオブジェクトまたはプラグインスタイルのハンドル
keyName	Name of item to remove from list.	項目の名前

Result:

TRUE if item is removed from list.

FALSE if hObj is NULL; if hObj is not a styled plug-in object or plug-in style
FALSE if item does not appear in list.

返り値

リストから項目を削除できた場合TRUEを返します。
[[BR]指定したハンドルがNULLの場合、指定したハンドルがプラグインオブジェクトかプラグインスタイルのハンドルでない場合はFALSEを返します。
指定した項目がリストにない場合はFALSEを返します。

See Also:

AddToPIOStyleEdit  

VectorScript Declaration:

FUNCTION   SelectPluginCatalog

( hSymbol:HANDLE ) :BOOLEAN ;

Python:

def  vs.SelectPluginCatalog(hSymbol):

   return BOOLEAN

Description:

Brings up a dialog to select a catalog to attach to a plug-in style, change the attached catalog, or detach the current catalog.

説明

ダイアログを表示し、プラグインスタイルに割り当てるカタログの選択・変更・削除を行います。

Parameters:

hSymbol

Handle to a symbol the defines a plug-in style.

シンボルのハンドル

Result:

FALSE if the object is not a symbol, does not define a plug-in sytle, or does not support catalogs.

返り値

オブジェクトがシンボルでない、定義がプラグインスタイルでない、カタログをサポートしていない場合はFALSEを返します。

VectorScript Declaration:

FUNCTION   Set2DCompByStyle

(   hObject :HANDLE;     byStyle :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.Set2DCompByStyle(hObject, byStyle):

   return BOOLEAN

VectorScript Declaration:

FUNCTION   Set2DCompLocation

(   hObject :HANDLE;     component :INTEGER;     onBoundsCube :BOOLEAN;     offset :REAL ) :BOOLEAN ;

Python:

def  vs.Set2DCompLocation(hObject, component, onBoundsCube, offset):

   return BOOLEAN

VectorScript Declaration:

FUNCTION   Set2DComponentGroup

(   objectHandle :HANDLE;     groupHandle :HANDLE;     component :INTEGER ) :BOOLEAN ;

Python:

def  vs.Set2DComponentGroup(objectHandle, groupHandle, component):

   return BOOLEAN

Description:

Sets the specified 2D component group of a symbol definition or plug-in object. Use Top/Plan if you want to add the group into the main container of the object.

Table - 2D Components

2D Component	Constant
Not Set	0
Top	1
Bottom	2
Top and Bottom Cut	3
Front	4
Back	5
Front and Back Cut	6
Left	7
Right	8
Left and Right Cut	9
Top/Plan	10

説明

指定したシンボル定義、またはプラグインオブジェクトの2Dコンポーネントグループを設定します。オブジェクトのメインコンテナにこのグループを追加したい場合は、2D/平面を指定します。

Table - 2D Components

2D Component	Constant
Not Set	0
Top	1
Bottom	2
Top and Bottom Cut	3
Front	4
Back	5
Front and Back Cut	6
Left	7
Right	8
Left and Right Cut	9

Parameters:

objectHandle	Handle to the object.	オブジェクトのハンドル
groupHandle	Handle to the graphics group. Can be a group or a single object. To delete the corresponding group provide NULL.	グラフィックスグループのハンドル。グループまたは単一のオブジェクトを指定可能。グループを削除する場合NULLを指定する。
component	2D component.	2Dコンポーネント

Result:

Returns TRUE if the operation was successful.

返り値

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

See Also:

Get2DComponentGroup  

VectorScript Declaration:

PROCEDURE   SetAllStyleParams

(   hStyle :HANDLE;     styleType :INTEGER ) ;

Python:

def  vs.SetAllStyleParams(hStyle, styleType):

   return None

Parameters:

hStyle	Handle to a symbol definition contain a plug-in style	プラグインスタイルのハンドル
styleType	0 = Set all parameters to be ny istance parameters 1 = Set all parameters to be by stuyle parameters	0 = すべてのパラメータでインスタンスの値を使用する; 1 = すべてのパラメータでスタイルの値を使用する

VectorScript Declaration:

FUNCTION   SetClassByStyle

(   hObject :HANDLE;     byStyle :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.SetClassByStyle(hObject, byStyle):

   return BOOLEAN

説明

指定したシンボル定義、プラグインオブジェクトのスタイル、またはプラグインオブジェクトのクラスに、スタイルによるクラスを設定します。

VectorScript Declaration:

FUNCTION   SetCustomFeedback

(   ParametricHandle :HANDLE;     FeedbackGroup :HANDLE ) :Boolean ;

Python:

def  vs.SetCustomFeedback(ParametricHandle, FeedbackGroup):

   return Boolean

Description:

Attaches a group of objects to a parametric used only for display on screen, this group will not export or print.

説明

画面上の表示にのみ使用されているパラメトリック図形のグループを連結します。このグループは取り出しやプリントはされません。

Parameters:

ParametricHandle	The parametric object to which the feedback group will be added.	パラメトリック図形のハンドル
FeedbackGroup	The feedback group which will only display on screen.	連結するグループのハンドル

Result:

True if the feedback group was successfully added to the parametric, false if the object was not a parametric or the feedback objects were not a group.

返り値

パラメトリック図形に連結できた場合TRUEを返します。

VectorScript Declaration:

FUNCTION   SetCustomObjectColor

(   objectHand :HANDLE;     inTagID :INTEGER;     inColoIndex :INTEGER ) :BOOLEAN ;

Python:

def  vs.SetCustomObjectColor(objectHand, inTagID, inColoIndex):

   return BOOLEAN

Description:

Store/Set an auxilary color index in 'objectHand' so GetCustomObjectColor can access it later. Application will preserve the color mapped to inTagID.

説明

「objectHand」に色を保管/設定します。GetCustomObjectColorを使ってこの色を使用できます。色はinTagIDに保持されます。

Parameters:

objectHand

Handle to object.

図形のハンドル

Result:

Returns TRUE if the operation was successful.

返り値

設定できた場合はTRUEを返します。

See Also:

GetCustomObjectColor  

VectorScript Declaration:

FUNCTION   SetCustomObjectPath

(   objectHand :HANDLE;     path :HANDLE ) :BOOLEAN ;

Python:

def  vs.SetCustomObjectPath(objectHand, path):

   return BOOLEAN

Description:

Replaces the path of an existing path plug-in object. The path is used as-is; no translation of vertices is performed.

説明

ハンドルで指定したプラグインオブジェクトのパス図形を設定します。

Parameters:

objectHand	Handle to object.	プラグインオブジェクトのハンドル
path	Handle to new path polygon.	パス図形（曲線 or NURBS）のハンドル

Result:

Returns TRUE if the operation was successful.

返り値

設定できた場合はTRUEを返します。

See Also:

GetCustomObjectPath  

VectorScript Declaration:

FUNCTION   SetCustomObjectProfileGroup

(   objectHand :HANDLE;     profileGroupHand :HANDLE ) :BOOLEAN ;

Python:

def  vs.SetCustomObjectProfileGroup(objectHand, profileGroupHand):

   return BOOLEAN

Description:

Sets the profile group for a path custom object.

説明

ハンドルで指定したプラグインオブジェクトの輪郭図形のハンドルを設定します。

Parameters:

objectHand	Handle to object.	プラグインオブジェクトのハンドル
profileGroupHand	Handle to profile group.	輪郭図形のハンドル

Result:

Returns TRUE if the operation was successful.

返り値

設定できた場合はTRUEを返します。

See Also:

GetCustomObjectProfileGroup  

VectorScript Declaration:

FUNCTION   SetCustomObjectSelectionGroup

(   objectHand :HANDLE;     selGroup :HANDLE ) :BOOLEAN ;

Python:

def  vs.SetCustomObjectSelectionGroup(objectHand, selGroup):

   return BOOLEAN

Description:

Set selection indication geometry for a parametric object.

説明

ハンドルで指定したプラグインオブジェクトが選択された際に、強調表示する形状を設定します。

Parameters:

objectHand	Handle to parametric object.	プラグインオブジェクトのハンドル
selGroup	Handle to object or group that contains geometry for selection indication.	選択された際に、強調表示する図形または図形のグループのハンドル

Result:

Returns TRUE if the operation was successful.

返り値

設定できた場合はTRUEを返します。

VectorScript Declaration:

FUNCTION   SetCustomObjectWallHoleGroup

(   objectHand :HANDLE;     holeGroup :HANDLE ) :BOOLEAN ;

Python:

def  vs.SetCustomObjectWallHoleGroup(objectHand, holeGroup):

   return BOOLEAN

Description:

Set wall hole geometry for a parametric object.

説明

ハンドルで指定したプラグインオブジェクトが壁に挿入された際に、壁に作られる開口部の形状を設定します。

Parameters:

objectHand	Handle to parametric object.	プラグインオブジェクトのハンドル
holeGroup	Handle to object or group that contains geometry for wall hole.	壁の開口部を示す図形または図形のグループのハンドル

Result:

Returns TRUE if the operation was successful.

返り値

設定できた場合はTRUEを返します。

VectorScript Declaration:

FUNCTION   SetDisplayWith2DComp

(   objectHandle :HANDLE;     component :INTEGER;     isVisible :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.SetDisplayWith2DComp(objectHandle, component, isVisible):

   return BOOLEAN

Description:

Sets whether a 3D object in a symbol definition or plug-in object is shown when the specified 2D component is shown.

Table - 2D Components

2D Component	Constant
Not Set	0
Top	1
Bottom	2
Top and Bottom Cut	3
Front	4
Back	5
Front and Back Cut	6
Left	7
Right	8
Left and Right Cut	9

説明

指定したシンボル定義またはプラグインオブジェクトの3Dオブジェクトを、指定した2Dコンポーネントの表示時に表示させるかどうかを設定します。
Table - 2D Components

2D Component	Constant
Not Set	0
Top	1
Bottom	2
Top and Bottom Cut	3
Front	4
Back	5
Front and Back Cut	6
Left	7
Right	8
Left and Right Cut	9
Top/Plan	10

Parameters:

objectHandle	3D object handle.	3Dオブジェクトのハンドル
component	2D component.	2Dコンポーネント
isVisible	Visibility of the object when the 2D component is shown.	表示する/しない

Result:

TRUE if the operation succeeded.

返り値

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

See Also:

Set2DComponentGroup   Get2DComponentGroup  

VectorScript Declaration:

FUNCTION   SetExWllClsrFrmSt

(   hObject :HANDLE;     left :BOOLEAN;     right :BOOLEAN;     top :BOOLEAN;     bottom :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.SetExWllClsrFrmSt(hObject, left, right, top, bottom):

   return BOOLEAN

Description:

Sets the exclude wall closure from settings of a symbol definition, plug-in object style, or plug-in object.

説明

シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクトの設定から「壁との取り合い設定を除外」設定をするように設定します。

Parameters:

hObject	The symbol definition, plug-in object style, or plug-in object.	シンボル定義、プラグインオブジェクトスタイル、またはプラグインオブジェクト
left	The exclude wall closure from left setting.	「壁との取り合い設定を除外」設定の左側の設定
right	The exclude wall closure from right setting.	「壁との取り合い設定を除外」設定の右側の設定
top	The exclude wall closure from top setting.	「壁との取り合い設定を除外」設定の上側の設定
bottom	The exclude wall closure from bottom setting.	「壁との取り合い設定を除外」設定の下側の設定

Result:

Whether the call succeeded.

返り値

呼び出し成功の可否

See Also:

GetExWllClsrFrmSt  

VectorScript Declaration:

FUNCTION   SetHorizSecCPByStyle

(   hObject :HANDLE;     byStyle :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.SetHorizSecCPByStyle(hObject, byStyle):

   return BOOLEAN

VectorScript Declaration:

FUNCTION   SetHorizSecCutPlane

(   hObject :HANDLE;     objectCutPlane :INTEGER ) :BOOLEAN ;

Python:

def  vs.SetHorizSecCutPlane(hObject, objectCutPlane):

   return BOOLEAN

VectorScript Declaration:

FUNCTION   SetMirrorEmpty2DComp

(   objectHandle :HANDLE;     doMirror :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.SetMirrorEmpty2DComp(objectHandle, doMirror):

   return BOOLEAN

Description:

Sets whether the opposite view graphics are mirrored for empty 2D components of a symbol definition or plug-in object.

説明

指定したシンボル定義、またはプラグインオブジェクトの存在しない2Dコンポーネントに、反対側のビューのグラフィックをミラー複製するかどうかを設定します。

Parameters:

objectHandle	Handle of a symbol or plug-in object.	シンボル定義またはプラグインオブジェクトのハンドル
doMirror	Whether the opposite view graphics are mirrored for empty 2D components.	反対側のビューのグラフィックをミラー複製する/しない

Result:

TRUE if the operation succeeded.

返り値

TRUE if the operation succeeded.

See Also:

GetMirrorEmpty2DComp   Get2DComponentGroup   Set2DComponentGroup