VectorScript Declaration:

PROCEDURE   BeginColumn

( columnDistance:REAL (Coordinate) ) ;

Python:

def  vs.BeginColumn(columnDistance):

   return None

Description:

Procedure BeginColumn creates a column object in a Vectorworks document using 2D object creation procedure calls to define the "template" for the column object.

After specifying object procedure calls to define the column, you should call EndGroup to complete the column definition and create the actual object.

説明

柱の高さを設定します。この手続きを実行してから、EndGroupが実行されるまでの間に作成された2次元図形を底面とする柱を作成します。

Parameters:

columnDistance

Height of column.

柱の高さ

Example:

BeginColumn(12');
  Oval(2',2',6',6');
EndGroup;

VectorScript Declaration:

PROCEDURE   BeginFloor

( thicknessDistance:REAL (Coordinate) ) ;

Python:

def  vs.BeginFloor(thicknessDistance):

   return None

Description:

Procedure BeginFloor creates a new floor object in a Vectorworks document. BeginFloor uses 2D object creation procedure calls to define the "template" for the object.

After specifying object procedure calls to define the floor object, you should call EndGroup to complete the column definition and create the actual object.

説明

床の厚みを設定します。この手続きを実行してから、EndObjectが実行されるまでの間に作成された2次元図形から床を作成します。

Parameters:

thicknessDistance

Floor thickness.

床の厚み

Example:

BeginFloor(6");
Rect(1,1,5,5);
EndGroup;

VectorScript Declaration:

PROCEDURE   ConvertToUnstyledSlab

( slab:HANDLE ) ;

Python:

def  vs.ConvertToUnstyledSlab(slab):

   return None

Description:

Sets a slab to be unstyled.

説明

スラブスタイルを「なし」に設定します。

Parameters:

slab

The slab.

スラブ

VectorScript Declaration:

FUNCTION   CreateRoofStyle

( roofStyleName:STRING ) :HANDLE ;

Python:

def  vs.CreateRoofStyle(roofStyleName):

   return HANDLE

Description:

Creates a new Roof Style of the given name. If the name is already in use, the next available name will be used.

説明

指定した名前の新しい屋根スタイルを作成します。すでに名前が使われている場合は次に可能な名前となります。

Parameters:

roofStyleName

The name of the new Roof Style. If the name is already in use, the next available name will be used.

屋根スタイルの名前

Result:

The new Roof Style.

返り値

新しい屋根スタイルのハンドル

VectorScript Declaration:

FUNCTION   CreateSlab

( profile:HANDLE ) :HANDLE ;

Python:

def  vs.CreateSlab(profile):

   return HANDLE

Description:

Creates a slab.

説明

スラブを作成します。

Parameters:

profile

The profile from which to create the slab.

スラブを作る元となる輪郭形状

Result:

The slab.

返り値

スラブ

See Also:

ModifySlab  

VectorScript Declaration:

FUNCTION   CreateSlabStyle

( slabStyleName:STRING ) :HANDLE ;

Python:

def  vs.CreateSlabStyle(slabStyleName):

   return HANDLE

Description:

Creates a new Slab Style of the given name. If the name is already in use, the next available name will be used.

説明

指定した名前の新しいスラブスタイルを作成します。すでに名前が使われている場合は次に可能な名前となります。

Parameters:

slabStyleName

The name of the new Slab Style. If the name is already in use, the next available name will be used.

新しいスラブスタイルの名前。

Result:

The new Slab Style.

返り値

新しいスラブスタイル

VectorScript Declaration:

FUNCTION   DeleteAllComponents

( object:HANDLE ) :BOOLEAN ;

Python:

def  vs.DeleteAllComponents(object):

   return BOOLEAN

Description:

Deletes all components in an object.

説明

ハンドルで指定した壁または壁スタイルの全構成要素を削除します。
ハンドルがNILならば、デフォルト壁スタイルに作用します。

Parameters:

object

The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.

オブジェクトのハンドル（壁、円弧壁、壁スタイルまたは、壁設定）

VectorScript Declaration:

FUNCTION   DeleteComponent

(   object :HANDLE;     componentIndex :INTEGER ) :BOOLEAN ;

Python:

def  vs.DeleteComponent(object, componentIndex):

   return BOOLEAN

Description:

Deletes a component in an object.

説明

壁の構成要素を番号を指定して削除します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component to delete.	削除する構成要素の番号

See Also:

InsertNewComponent  

VectorScript Declaration:

PROCEDURE   DelObjStoryBound

(   object :HANDLE;     boundID :INTEGER ) ;

Python:

def  vs.DelObjStoryBound(object, boundID):

   return None

Description:

Delete the specified story bounds from this object.

説明

ハンドルで指定した図形の高さ基準を削除します。

Parameters:

object	The object.	図形のハンドル
boundID	The identifier of the story bound.	識別子

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

VectorScript Declaration:

PROCEDURE   DelObjStoryBounds

( object:HANDLE ) ;

Python:

def  vs.DelObjStoryBounds(object):

   return None

Description:

Delete all story bounds for this object.

説明

ハンドルで指定した図形の高さ基準をすべて削除します。

Parameters:

object

The object.

図形のハンドル

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

VectorScript Declaration:

FUNCTION   GetCompABoundEOffOff

(   object :HANDLE;     componentIndex :INTEGER;   VAR  autoBoundEdgeOffsetOffset :REAL ) :BOOLEAN ;

Python:

def  vs.GetCompABoundEOffOff(object, componentIndex):

   return (BOOLEAN, autoBoundEdgeOffsetOffset)

Description:

Gets the auto-bound edge offset offset of a component in an object.

説明

図形の構成要素の自動設定された境界の辺のオフセットを取得します。

Parameters:

object	The object. Can be a slab, Slab Style, or the Slab Preferences.	オブジェクトのハンドル（スラブ、スラブスタイルまたは、スラブ設定）
componentIndex	The index of the component.	構成要素の番号
autoBoundEdgeOffsetOffset	Returns the auto-bound edge offset offset.	オフセット

See Also:

SetCompABoundEOffOff  

VectorScript Declaration:

FUNCTION   GetCompAltSecFill

(   object :HANDLE;     componentIndex :INTEGER;   VAR  alternateSectionFill :LONGINT ) :BOOLEAN ;

Python:

def  vs.GetCompAltSecFill(object, componentIndex):

   return (BOOLEAN, alternateSectionFill)

Description:

Gets the alternate section fill of a component in an object.

説明

オブジェクトの構成要素の切り替え位置の面のスタイルを取得します。

Parameters:

object	The object. Can be a roof face, roof, Roof Style, or the Roof Preferences.	オブジェクトのハンドル（屋根、屋根スタイルまたは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
alternateSectionFill	Returns the alternate section fill of the component.	切り替え位置の面のスタイル

See Also:

SetCompAltSecFill  

VectorScript Declaration:

FUNCTION   GetCompAltSecFillCl

(   object :HANDLE;     componentIndex :INTEGER;   VAR  alternateSectionFillForeColor :INTEGER;   VAR  alternateSectionFillBackColor :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetCompAltSecFillCl(object, componentIndex):

   return (BOOLEAN, alternateSectionFillForeColor, alternateSectionFillBackColor)

Description:

Gets the alternate section fill colors of a component in an object.

説明

オブジェクトの構成要素の切り替え位置の面の前景色/背景色を取得します。

Parameters:

object	The object. Can be a roof face, roof, Roof Style, or the Roof Preferences.	オブジェクトのハンドル（屋根、屋根スタイルまたは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
alternateSectionFillForeColor	Returns the alternate section fill fore color of the component.	切り替え位置の面の模様の前景色
alternateSectionFillBackColor	Returns the alternate section fill back color of the component.	切り替え位置の面の模様の背景色

See Also:

SetCompAltSecFillCl  

VectorScript Declaration:

FUNCTION   GetCompAutoJoinCap

(   object :HANDLE;     componentIndex :INTEGER;   VAR  alwaysAutoJoinInCappedJoinMode :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompAutoJoinCap(object, componentIndex):

   return (BOOLEAN, alwaysAutoJoinInCappedJoinMode)

Description:

Gets the always auto join in Capped Join mode flag of a component in an object.

説明

オブジェクトの構成要素を常に突合わせ結合モードで自動結合させるかどうかのフラグを取得します。

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.	オブジェクトのハンドル（壁、円弧壁、壁スタイルまたは、壁設定）
componentIndex	The index of the component.	構成要素の番号
alwaysAutoJoinInCappedJoinMode	Returns whether or not the component always auto joins in Capped Join mode.	常に突合わせ結合モードで自動結合する／しない

See Also:

SetCompAutoJoinCap  

VectorScript Declaration:

FUNCTION   GetCompBotIsRelStory

(   object :HANDLE;     componentIndex :INTEGER;   VAR  bottomIsRelativeToStory :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompBotIsRelStory(object, componentIndex):

   return (BOOLEAN, bottomIsRelativeToStory)

Description:

Gets whether or not the component bottom is relative to a story.

説明

壁の構成要素の下端がストーリを基準にしているかどうかを返します。

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.	オブジェクトのハンドル（壁、円弧壁、壁スタイルまたは、壁設定）
componentIndex	The index of the component.	構成要素の番号
bottomIsRelativeToStory	Returns whether or not the component bottom is relative to a story.	図形の構成要素の下端がストーリを基準にしている／いない

See Also:

SetCompBotIsRelStory  

VectorScript Declaration:

FUNCTION   GetCompBoundOffset

(   object :HANDLE;     componentIndex :INTEGER;   VAR  boundOffset :REAL ) :BOOLEAN ;

Python:

def  vs.GetCompBoundOffset(object, componentIndex):

   return (BOOLEAN, boundOffset)

Description:

Gets the bound offset of a component in an object.

説明

オブジェクトの構成要素の境界のオフセットを取得します。

Parameters:

object	The object. Can be a roof face, roof, Roof Style, or the Roof Preferences.	オブジェクトのハンドル（屋根、屋根スタイルまたは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
boundOffset	Returns the bound offset of the component.	境界のオフセット

See Also:

SetCompBoundOffset  

VectorScript Declaration:

FUNCTION   GetCompDatTopOfComp

(   object :HANDLE;     componentIndex :INTEGER;   VAR  datumIsTopOfComponent :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompDatTopOfComp(object, componentIndex):

   return (BOOLEAN, datumIsTopOfComponent)

Description:

Gets the datum is top of component flag of a component in an object.

説明

オブジェクトの構成要素の基準面が構成要素の上端かどうかのフラグを取得します。

Parameters:

object	The object. Can be a slab, roof face, roof, Slab Style, Roof Style, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（スラブ、屋根、スラブスタイル、屋根スタイル、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
datumIsTopOfComponent	Returns whether or not the datum is the top of the component.	基準面が構成要素の上端かどうか

See Also:

SetCompDatTopOfComp  

VectorScript Declaration:

FUNCTION   GetCompInsertLoc

( object:HANDLE ) :INTEGER ;

Python:

def  vs.GetCompInsertLoc(object):

   return INTEGER

Description:

Gets the component insert location of the object.

説明

オブジェクトの構成要素挿入位置を取得します。

Parameters:

object

The object. Can be a wall, Wall Style, or the Wall Preferences.

指定するオブジェクト（壁、壁スタイル、または壁設定）

Result:

The component insert location of the object.

0 - None
1 - Left
2 - Center
3 - Right

返り値

オブジェクトの構成要素の挿入位置0 - なし1 - 左側2 - 中央3 - 右側

See Also:

SetCompInsertLoc  

VectorScript Declaration:

FUNCTION   GetCompInsertLocOff

( object:HANDLE ) :REAL ;

Python:

def  vs.GetCompInsertLocOff(object):

   return REAL

Description:

Gets the component insert location offset of the object.

説明

オブジェクトの構成要素挿入位置オフセットを取得します。

Parameters:

object

The object. Can be a wall, Wall Style, or the Wall Preferences.

指定するオブジェクト（壁、壁スタイル、または壁設定）

Result:

The component insert location offset of the object.

返り値

オブジェクトの構成要素挿入位置のオフセット

See Also:

SetCompInsertLocOff  

VectorScript Declaration:

FUNCTION   GetCompManualBound

(   object :HANDLE;     componentIndex :INTEGER;   VAR  manualBound :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetCompManualBound(object, componentIndex):

   return (BOOLEAN, manualBound)

Description:

Gets the manual bound of a component in an object.

説明

オブジェクトの構成要素の手動境界を取得します。

Parameters:

object	The object. Can be a roof face, roof, Roof Style, or the Roof Preferences.	オブジェクトのハンドル（屋根、屋根スタイルまたは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
manualBound	Returns the manual bound of the component. 0 - Roof edge 1 - Roof axis line	手動境界 0:屋根端部 1:屋根軸ライン

See Also:

SetCompManualBound  

VectorScript Declaration:

FUNCTION   GetCompMasterSnaps

(   object :HANDLE;     componentIndex :INTEGER;   VAR  masterSnapOnLeft :BOOLEAN;   VAR  masterSnapOnRight :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompMasterSnaps(object, componentIndex):

   return (BOOLEAN, masterSnapOnLeft, masterSnapOnRight)

Description:

Gets the master snaps of a component in an object.

説明

オブジェクトの構成要素のマスタースナップを取得します。

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.	オブジェクトのハンドル（壁、円弧壁、壁スタイルまたは、壁設定）
componentIndex	The index of the component.	構成要素の番号
masterSnapOnLeft	Returns whether or not the component has a master snap on its left.	構成要素の左側がマスタースナップを持つかどうか
masterSnapOnRight	Returns whether or not the component has a master snap on its right.	構成要素の右側がマスタースナップを持つかどうか

See Also:

SetCompMasterSnaps  

VectorScript Declaration:

FUNCTION   GetComponentAutoBoundEdgeOffset

(   object :HANDLE;     componentIndex :INTEGER;   VAR  autoBoundEdgeOffset :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetComponentAutoBoundEdgeOffset(object, componentIndex):

   return (BOOLEAN, autoBoundEdgeOffset)

Description:

Gets the auto-bound edge offset of a component in an object.

説明

図形の構成要素の自動設定された境界の辺のオフセットを取得します。

Parameters:

object	The object. Can be a slab, Slab Style, or the Slab Preferences.	オブジェクトのハンドル（スラブ、スラブスタイルまたは、スラブ設定）
componentIndex	The index of the component.	構成要素の番号
autoBoundEdgeOffset	Returns the auto-bound edge offset. 0 - Inner face 1 - Outer face of inner component 2 - Inner face of core 3 - Center of core 4 - Outer face of core 5 - Inner face of outer component	自動設定された境界のオフセット

See Also:

SetComponentAutoBoundEdgeOffset  

VectorScript Declaration:

FUNCTION   GetComponentClass

(   object :HANDLE;     componentIndex :INTEGER;   VAR  componentClass :LONGINT ) :BOOLEAN ;

Python:

def  vs.GetComponentClass(object, componentIndex):

   return (BOOLEAN, componentClass)

Description:

Gets the class of a component in an object.

説明

ハンドルで指定した壁の、指定した番号の構成要素からクラスを取得します。ハンドルがNILならば、この関数はデフォルト壁スタイルに作用します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
componentClass	Returns the class of the component.	構成要素のクラスの名前

See Also:

SetComponentClass  

VectorScript Declaration:

FUNCTION   GetComponentFill

(   object :HANDLE;     componentIndex :INTEGER;   VAR  fill :LONGINT ) :BOOLEAN ;

Python:

def  vs.GetComponentFill(object, componentIndex):

   return (BOOLEAN, fill)

Description:

Gets the fill of a component in an object.

説明

壁の中心線の線の模様を返します。成功した場合はTRUEを返します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定） NILの場合はデフォルト壁スタイルを参照します。
componentIndex	The index of the component.	構成要素の番号
fill	Returns the fill of the component. Positive values for patterns, negative ref numbers for hatches.	面の模様番号 模様は正の値、ハッチングは負の値で指定します。

See Also:

SetComponentFill  

VectorScript Declaration:

FUNCTION   GetComponentFillColors

(   object :HANDLE;     componentIndex :INTEGER;   VAR  fillForeColor :INTEGER;   VAR  fillBackColor :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetComponentFillColors(object, componentIndex):

   return (BOOLEAN, fillForeColor, fillBackColor)

Description:

Gets the fore and back fill colors of a component in an object.

説明

ハンドルで指定した壁の、指定した番号の構成要素から面の色と地色を取得します。ハンドルがNILならば、この関数はデフォルト壁スタイルに作用します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
fillForeColor	Returns the fore color of the fill.	面の色
fillBackColor	Returns the back color of the fill.	面の地色

See Also:

SetComponentFillColors  

VectorScript Declaration:

FUNCTION   GetComponentFollowBottomWallPeaks

(   object :HANDLE;     componentIndex :INTEGER;   VAR  followBottomWallPeaks :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetComponentFollowBottomWallPeaks(object, componentIndex):

   return (BOOLEAN, followBottomWallPeaks)

Description:

Gets the follow bottom wall peaks flag of a component in an object.

説明

図形の構成要素が壁の下端に端を合わせるかどうかのフラグを取得します。

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.	オブジェクトのハンドル（壁、円弧壁、壁スタイルまたは、壁設定）
componentIndex	The index of the component.	構成要素の番号
followBottomWallPeaks	Returns whether or not the component is following bottom wall peaks.	構成要素が壁の下端に端を合わせる／合わせない

See Also:

SetComponentFollowBottomWallPeaks  

VectorScript Declaration:

FUNCTION   GetComponentFollowTopWallPeaks

(   object :HANDLE;     componentIndex :INTEGER;   VAR  followTopWallPeaks :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetComponentFollowTopWallPeaks(object, componentIndex):

   return (BOOLEAN, followTopWallPeaks)

Description:

Gets the follow top wall peaks flag of a component in an object.

説明

図形の構成要素が壁の上端に端を合わせるかどうかのフラグを取得します。

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.	オブジェクトのハンドル（壁、円弧壁、壁スタイルまたは、壁設定）
componentIndex	The index of the component.	構成要素の番号
followTopWallPeaks	Returns whether or not the component is following top wall peaks.	構成要素が壁の上端に端を合わせる／合わせない

See Also:

SetComponentFollowTopWallPeaks  

VectorScript Declaration:

FUNCTION   GetComponentFunction

(   object :HANDLE;     componentIndex :INTEGER;   VAR  func :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetComponentFunction(object, componentIndex):

   return (BOOLEAN, func)

Description:

Gets the function of a component in an object.

説明

オブジェクトの構成要素の用途を返します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根面、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定、または屋根設定）
componentIndex	The index of the component.	構成要素の番号
func	Returns the function of the component. 0 - Other 1 - Load-Bearing 2 - Insulation 3 - Inner Finish 4 - Outer Finish 5 - Air Gap	用途:（0: その他、1: 躯体、2: 断熱、3 内部仕上げ、4: 外部仕上げ、5: 空気層）

See Also:

SetComponentFunction  

VectorScript Declaration:

FUNCTION   GetComponentManualEdgeOffset

(   object :HANDLE;     componentIndex :INTEGER;   VAR  manualEdgeOffset :REAL ) :BOOLEAN ;

Python:

def  vs.GetComponentManualEdgeOffset(object, componentIndex):

   return (BOOLEAN, manualEdgeOffset)

Description:

Gets the manual edge offset of a component in an object.

説明

図形の構成要素の手動設定された境界の辺のオフセットを取得します。

Parameters:

object	The object. Can be a slab, Slab Style, or the Slab Preferences.	オブジェクトのハンドル（スラブ、スラブスタイルまたは、スラブ設定）
componentIndex	The index of the component.	構成要素の番号
manualEdgeOffset	Returns the manual edge offset.	手動設定された境界のオフセットを返します

See Also:

SetComponentManualEdgeOffset  

VectorScript Declaration:

FUNCTION   GetComponentMaterial

(   object :HANDLE;     componentIndex :INTEGER;   VAR  material :LONGINT ) :BOOLEAN ;

Python:

def  vs.GetComponentMaterial(object, componentIndex):

   return (BOOLEAN, material)

Description:

Gets the material of a component in an object.

説明

指定したオブジェクトの指定した構成要素のマテリアルを取得します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	指定するオブジェクトのハンドル（壁、円弧壁、スラブ、屋根面、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定、または屋根設定）です。
componentIndex	The index of the component.	構成要素の番号
material	Returns the material of the component.	構成要素のマテリアル

See Also:

SetComponentMaterial  

VectorScript Declaration:

FUNCTION   GetComponentName

(   object :HANDLE;     componentIndex :INTEGER ) :STRING ;

Python:

def  vs.GetComponentName(object, componentIndex):

   return STRING

Description:

Gets the name of a component in an object.

説明

ハンドルで指定した壁の、指定した番号の構成要素から名前を取得します。ハンドルがNILならば、この関数はデフォルト壁スタイルに作用します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号

Result:

The name of the component.

返り値

構成要素の名前

See Also:

SetComponentName  

VectorScript Declaration:

FUNCTION   GetComponentNetArea

(   object :HANDLE;     componentIndex :INTEGER ) :REAL ;

Python:

def  vs.GetComponentNetArea(object, componentIndex):

   return REAL

Description:

Gets the net area of a component in an object.

説明

図形の構成要素の正味の面積を取得します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号

Result:

The net area of the component.

返り値

構成要素の正味の面積

See Also:

GetComponentNetVolume  

VectorScript Declaration:

FUNCTION   GetComponentNetVolume

(   object :HANDLE;     componentIndex :INTEGER ) :REAL ;

Python:

def  vs.GetComponentNetVolume(object, componentIndex):

   return REAL

Description:

Gets the net volume of a component in an object.

説明

図形の構成要素の正味の体積を取得します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号

Result:

The net volume of the component.

返り値

構成要素の正味の体積

See Also:

GetComponentNetArea  

VectorScript Declaration:

FUNCTION   GetComponentPenColors

(   object :HANDLE;     componentIndex :INTEGER;   VAR  leftPenForeColor :INTEGER;   VAR  leftPenBackColor :INTEGER;   VAR  rightPenForeColor :INTEGER;   VAR  rightPenBackColor :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetComponentPenColors(object, componentIndex):

   return (BOOLEAN, leftPenForeColor, leftPenBackColor, rightPenForeColor, rightPenBackColor)

Description:

Gets the colors of the pens of a component in an object.

説明

ハンドルで指定した壁の、指定した番号の構成要素から線の色を取得します。ハンドルがNILならば、この関数はデフォルト壁スタイルに作用します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
leftPenForeColor	Returns the fore color of the left pen.	左の線の色
leftPenBackColor	Returns the back color of the left pen.	左の線の地色
rightPenForeColor	Returns the fore color of the right pen.	右の線の色
rightPenBackColor	Returns the back color of the right pen.	右の線の地色

See Also:

SetComponentPenColors  

VectorScript Declaration:

FUNCTION   GetComponentPenStyles

(   object :HANDLE;     componentIndex :INTEGER;   VAR  leftPenStyle :INTEGER;   VAR  rightPenStyle :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetComponentPenStyles(object, componentIndex):

   return (BOOLEAN, leftPenStyle, rightPenStyle)

Special Notes:

GetComponentPenStyles is obsolete as of Vectorworks 2019

Description:

Deprecated - will generate error. Use GetCompPenStylesN instead.

説明

ハンドルで指定した壁で、指定した番号の構成要素から左右の線の種類を取得します。
ハンドルがNILならば、デフォルト壁スタイルの値を取得します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
leftPenStyle	Returns the pen style of the component's left line. Positive values for patterns, negative values for dash styles.	構成要素の左側の線の種類 破線の種類は負の値です。
rightPenStyle	Returns the pen style of the component's right line. Positive values for patterns, negative values for dash styles.	構成要素の右側の線の種類 破線の種類は負の値です。

See Also:

GetCompPenStylesN  

VectorScript Declaration:

FUNCTION   GetComponentPenWeights

(   object :HANDLE;     componentIndex :INTEGER;   VAR  leftPenWeight :INTEGER;   VAR  rightPenWeight :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetComponentPenWeights(object, componentIndex):

   return (BOOLEAN, leftPenWeight, rightPenWeight)

Description:

Gets the pen weights of the left and right sides of a component in an object.

説明

ハンドルで指定した壁で、指定した番号の構成要素から左右の線の太さを取得します。
ハンドルがNILならば、デフォルト壁スタイルに作用します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
leftPenWeight	Returns the pen weight of the component's left line.	構成要素の左側の線の太さ
rightPenWeight	Returns the pen weight of the component's right line.	構成要素の右側の線の太さ

See Also:

SetComponentPenWeights  

VectorScript Declaration:

FUNCTION   GetComponents

( object:HANDLE ) :HANDLE ;

Python:

def  vs.GetComponents(object):

   return HANDLE

Description:

Gets the components of the object.

説明

図形の構成要素のハンドルを返します。

Parameters:

object

The object. Can be a wall, round wall, slab, Wall Style, Slab Style, the Wall Preferences, or the Slab Preferences.

壁、円弧壁、壁スタイルまたはスラブスタイルのハンドル

VectorScript Declaration:

FUNCTION   GetComponentTexture

(   object :HANDLE;     componentIndex :INTEGER;   VAR  texture :LONGINT ) :BOOLEAN ;

Python:

def  vs.GetComponentTexture(object, componentIndex):

   return (BOOLEAN, texture)

Description:

Gets the texture of a component in an object.

説明

図形の構成要素のテクスチャを取得します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
texture	Returns the ref number of the texture. 0 for no texture. -1 for class texture.	テクスチャの参照番号を返します。テクスチャがない場合は0、クラステクスチャの場合は-1。

See Also:

SetComponentTexture  

VectorScript Declaration:

FUNCTION   GetComponentUseFillClassAttr

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useFillClassAttributes :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetComponentUseFillClassAttr(object, componentIndex):

   return (BOOLEAN, useFillClassAttributes)

Description:

Gets the use fill class attributes flag of a component in an object.

説明

ハンドルで指定した壁の、指定した番号の構成要素で面の模様で、クラス属性を使用しているかどうかを返します。ハンドルがNILならば、この関数はデフォルト壁スタイルに作用します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
useFillClassAttributes	Returns whether or not the component is using class attributes for its fill.	面の模様にクラス属性を使用している／いない

See Also:

SetComponentUseFillClassAttr  

VectorScript Declaration:

FUNCTION   GetComponentUsePenClassAttr

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useLeftPenClassAttributes :BOOLEAN;   VAR  useRightPenClassAttributes :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetComponentUsePenClassAttr(object, componentIndex):

   return (BOOLEAN, useLeftPenClassAttributes, useRightPenClassAttributes)

Description:

Gets the use class attributes flags of the pens of a component in an object.

説明

ハンドルで指定した壁の、指定した番号の構成要素で左右の線種で、クラス属性を使用しているかどうかを返します。ハンドルがNILならば、この関数はデフォルト壁スタイルに作用します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
useLeftPenClassAttributes	Returns whether or not the component is using class attributes for its left pen.	左の線種にクラス属性を使用している／いない
useRightPenClassAttributes	Returns whether or not the component is using class attributes for its right pen.	右の線種にクラス属性を使用している／いない

See Also:

SetComponentUsePenClassAttr  

VectorScript Declaration:

FUNCTION   GetComponentWallBottomOffset

(   object :HANDLE;     componentIndex :INTEGER;   VAR  offsetFromWallBottom :REAL ) :BOOLEAN ;

Python:

def  vs.GetComponentWallBottomOffset(object, componentIndex):

   return (BOOLEAN, offsetFromWallBottom)

Description:

Gets the offset from wall bottom of a component in an object.

説明

図形の構成要素の壁の下端からのオフセットを取得します。

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.	オブジェクトのハンドル（壁、円弧壁、壁スタイルまたは、壁設定）
componentIndex	The index of the component.	構成要素の番号
offsetFromWallBottom	Returns the offset from wall bottom of the component.	構成要素の壁の下端からのオフセットを返します。.

See Also:

SetComponentWallBottomOffset  

VectorScript Declaration:

FUNCTION   GetComponentWallTopOffset

(   object :HANDLE;     componentIndex :INTEGER;   VAR  offsetFromWallTop :REAL ) :BOOLEAN ;

Python:

def  vs.GetComponentWallTopOffset(object, componentIndex):

   return (BOOLEAN, offsetFromWallTop)

Description:

Gets the offset from wall top of a component in an object.

説明

図形の構成要素の壁の上端からのオフセットを取得します。

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.	オブジェクトのハンドル（壁、円弧壁、壁スタイルまたは、壁設定）
componentIndex	The index of the component.	構成要素の番号
offsetFromWallTop	Returns the offset from wall top of the component.	構成要素の壁の上端からのオフセットを返します。.

See Also:

SetComponentWallTopOffset  

VectorScript Declaration:

FUNCTION   GetComponentWidth

(   object :HANDLE;     componentIndex :INTEGER;   VAR  width :REAL ) :BOOLEAN ;

Python:

def  vs.GetComponentWidth(object, componentIndex):

   return (BOOLEAN, width)

Description:

Gets the width of a component in an object.

説明

ハンドルで指定した壁で、指定した番号の構成要素から幅を取得します。
ハンドルがNILならば、デフォルト壁スタイルに作用します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
width	Returns the width of the component.	構成要素の幅

See Also:

SetComponentWidth  

VectorScript Declaration:

FUNCTION   GetCompPenStylesN

(   object :HANDLE;     componentIndex :INTEGER;   VAR  leftPenStyle :LONGINT;   VAR  rightPenStyle :LONGINT ) :BOOLEAN ;

Python:

def  vs.GetCompPenStylesN(object, componentIndex):

   return (BOOLEAN, leftPenStyle, rightPenStyle)

Description:

Gets the pen styles of a component in an object.

説明

オブジェクトの構成要素の線のスタイルを取得します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
leftPenStyle	Returns the left pen style of the component.	左の線のスタイル
rightPenStyle	Returns the right pen style of the component.	右の線のスタイル

See Also:

SetCompPenStylesN  

VectorScript Declaration:

FUNCTION   GetCompSecFillChgPt

(   object :HANDLE;     componentIndex :INTEGER;   VAR  wallAssociatedSectionFillChangePoint :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetCompSecFillChgPt(object, componentIndex):

   return (BOOLEAN, wallAssociatedSectionFillChangePoint)

Description:

Gets the wall associated section fill change point of a component in an object.

説明

オブジェクトの構成要素の壁結合時の切り替え位置を取得します。

Parameters:

object	The object. Can be a roof face, roof, Roof Style, or the Roof Preferences.	オブジェクトのハンドル（屋根、屋根スタイルまたは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
wallAssociatedSectionFillChangePoint	Returns the wall associated section fill change point of the component. 0 - Inner face 1 - Outer face of inner component 2 - Inner face of core 3 - Center of core 4 - Outer face of core 5 - Inner face of outer component 6 - None	壁結合時の切り替え位置

See Also:

SetCompSecFillChgPt  

VectorScript Declaration:

FUNCTION   GetCompTopIsRelStory

(   object :HANDLE;     componentIndex :INTEGER;   VAR  topIsRelativeToStory :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompTopIsRelStory(object, componentIndex):

   return (BOOLEAN, topIsRelativeToStory)

Description:

Gets whether or not the component top is relative to a story.

説明

壁の構成要素の上端がストーリを基準にしているかどうかを返します。

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.	オブジェクトのハンドル（壁、円弧壁、壁スタイルまたは、壁設定）
componentIndex	The index of the component.	構成要素の番号
topIsRelativeToStory	Returns whether or not the component top is relative to a story.	図形の構成要素の上端がストーリを基準にしている／いない

See Also:

SetCompTopIsRelStory  

VectorScript Declaration:

FUNCTION   GetCompUseClassASF

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useClassFillStyleForAlternateSectionFill :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompUseClassASF(object, componentIndex):

   return (BOOLEAN, useClassFillStyleForAlternateSectionFill)

Description:

Gets the use class fill style for alternate section fill flag of a component in an object.

説明

オブジェクトの構成要素の切り替え位置の面にクラス属性のスタイルを使用しているかどうかのフラグを取得します。

Parameters:

object	The object. Can be a roof face, roof, Roof Style, or the Roof Preferences.	オブジェクトのハンドル（屋根、屋根スタイルまたは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
useClassFillStyleForAlternateSectionFill	Returns whether or not the component is using class attributes for its alternate section fill.	切り替え位置の面にクラス属性のスタイルを使用している／いない

See Also:

SetCompUseClassASF  

VectorScript Declaration:

FUNCTION   GetCompUseClassASFCl

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useClassFillColorsForAlternateSectionFill :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompUseClassASFCl(object, componentIndex):

   return (BOOLEAN, useClassFillColorsForAlternateSectionFill)

Description:

Gets the use class fill colors for alternate section fill flag of a component in an object.

説明

オブジェクトの構成要素の切り替え位置の面にクラス属性の色を使用しているかどうかのフラグを取得します。

Parameters:

object	The object. Can be a roof face, roof, Roof Style, or the Roof Preferences.	オブジェクトのハンドル（屋根、屋根スタイルまたは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
useClassFillColorsForAlternateSectionFill	Returns whether or not the component is using class attributes for its alternate section fill colors.	切り替え位置の面にクラス属性の色を使用している／いない

See Also:

SetCompUseClassASFCl  

VectorScript Declaration:

FUNCTION   GetCompUseClassFCl

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useClassFillColorsForFill :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompUseClassFCl(object, componentIndex):

   return (BOOLEAN, useClassFillColorsForFill)

Description:

Gets the use class fill colors for fill flag of a component in an object.

説明

オブジェクトの構成要素の面にクラス属性の面の色を使用しているかどうかのフラグを取得します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
useClassFillColorsForFill	Returns whether or not the component is using class attributes for its fill colors.	クラス属性の面の色を使用している／いない

See Also:

SetCompUseClassFCl  

VectorScript Declaration:

FUNCTION   GetCompUseClassFill

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useClassFillStyleForFill :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompUseClassFill(object, componentIndex):

   return (BOOLEAN, useClassFillStyleForFill)

Description:

Gets the use class fill style for fill flag of a component in an object.

説明

オブジェクトの構成要素の面にクラス属性の面のスタイルを使用しているかどうかのフラグを取得します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
useClassFillStyleForFill	Returns whether or not the component is using class attributes for its fill.	クラス属性の面のスタイルを使用している／いない

See Also:

SetCompUseClassFill  

VectorScript Declaration:

FUNCTION   GetCompUseClassLPCl

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useClassPenColorsForLeftPen :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompUseClassLPCl(object, componentIndex):

   return (BOOLEAN, useClassPenColorsForLeftPen)

Description:

Gets the use class pen colors for left pen flag of a component in an object.

説明

オブジェクトの構成要素の線種（左側）にクラス属性の線の色を使用しているかどうかのフラグを取得します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
useClassPenColorsForLeftPen	Returns whether or not the component is using class attributes for its left pen colors.	クラス属性の線の色を使用している／いない

See Also:

SetCompUseClassLPCl  

VectorScript Declaration:

FUNCTION   GetCompUseClassLPS

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useClassPenStyleForLeftPen :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompUseClassLPS(object, componentIndex):

   return (BOOLEAN, useClassPenStyleForLeftPen)

Description:

Gets the use class pen style for left pen flag of a component in an object.

説明

オブジェクトの構成要素の線種（左側）にクラス属性のスタイルを使用しているかどうかのフラグを取得します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
useClassPenStyleForLeftPen	Returns whether or not the component is using class attributes for its left pen style.	クラス属性のスタイルを使用している／いない

See Also:

SetCompUseClassLPS  

VectorScript Declaration:

FUNCTION   GetCompUseClassLPW

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useClassPenWeightForLeftPen :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompUseClassLPW(object, componentIndex):

   return (BOOLEAN, useClassPenWeightForLeftPen)

Description:

Gets the use class pen weight for left pen flag of a component in an object.

説明

オブジェクトの構成要素の線種（左側）にクラス属性の線の太さを使用しているかどうかのフラグを取得します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
useClassPenWeightForLeftPen	Returns whether or not the component is using class attributes for its left pen weight.	クラス属性の線の太さを使用している／いない

See Also:

SetCompUseClassLPW  

VectorScript Declaration:

FUNCTION   GetCompUseClassRPCl

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useClassPenColorsForRightPen :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompUseClassRPCl(object, componentIndex):

   return (BOOLEAN, useClassPenColorsForRightPen)

Description:

Gets the use class pen colors for right pen flag of a component in an object.

説明

オブジェクトの構成要素の線種（右側）にクラス属性の線の色を使用しているかどうかのフラグを取得します。

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.	オブジェクトのハンドル（壁、円弧壁、壁スタイルまたは、壁設定）
componentIndex	The index of the component.	構成要素の番号
useClassPenColorsForRightPen	Returns whether or not the component is using class attributes for its right pen colors.	クラス属性の線の色を使用している／いない

See Also:

SetCompUseClassRPCl  

VectorScript Declaration:

FUNCTION   GetCompUseClassRPS

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useClassPenStyleForRightPen :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompUseClassRPS(object, componentIndex):

   return (BOOLEAN, useClassPenStyleForRightPen)

Description:

Gets the use class pen style for right pen flag of a component in an object.

説明

オブジェクトの構成要素の線種（右側）にクラス属性のスタイルを使用しているかどうかのフラグを取得します。

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.	オブジェクトのハンドル（壁、円弧壁、壁スタイルまたは、壁設定）
componentIndex	The index of the component.	構成要素の番号
useClassPenStyleForRightPen	Returns whether or not the component is using class attributes for its right pen style.	クラス属性のスタイルを使用している／いない

See Also:

SetCompUseClassRPS  

VectorScript Declaration:

FUNCTION   GetCompUseClassRPW

(   object :HANDLE;     componentIndex :INTEGER;   VAR  useClassPenWeightForRightPen :BOOLEAN ) :BOOLEAN ;

Python:

def  vs.GetCompUseClassRPW(object, componentIndex):

   return (BOOLEAN, useClassPenWeightForRightPen)

Description:

Gets the use class pen weight for right pen flag of a component in an object.

説明

オブジェクトの構成要素の線種（右側）にクラス属性の線の太さを使用しているかどうかのフラグを取得します。

Parameters:

object	The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.	オブジェクトのハンドル（壁、円弧壁、壁スタイルまたは、壁設定）
componentIndex	The index of the component.	構成要素の番号
useClassPenWeightForRightPen	Returns whether or not the component is using class attributes for its right pen weight.	クラス属性の線の太さを使用している／いない

See Also:

SetCompUseClassRPW  

VectorScript Declaration:

FUNCTION   GetCompWallAssBound

(   object :HANDLE;     componentIndex :INTEGER;   VAR  wallAssociatedBound :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetCompWallAssBound(object, componentIndex):

   return (BOOLEAN, wallAssociatedBound)

Description:

Gets the wall associated bound of a component in an object.

説明

オブジェクトの構成要素の壁結合時の端部の境界を取得します。

Parameters:

object	The object. Can be a roof face, roof, Roof Style, or the Roof Preferences.	オブジェクトのハンドル（屋根、屋根スタイルまたは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
wallAssociatedBound	Returns the wall associated bound of the component. 0 - Inner face 1 - Outer face of inner component 2 - Inner face of core 3 - Center of core 4 - Outer face of core 5 - Inner face of outer component 6 - Roof edge 7 - Roof axis line	壁結合時の端部の境界

See Also:

SetCompWallAssBound  

VectorScript Declaration:

FUNCTION   GetCompWallAssMod

(   object :HANDLE;     componentIndex :INTEGER;   VAR  wallAssociatedModification :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetCompWallAssMod(object, componentIndex):

   return (BOOLEAN, wallAssociatedModification)

Description:

Gets the wall associated modification of a component in an object.

説明

オブジェクトの構成要素の壁結合時の端部の調整を取得します。

Parameters:

object	The object. Can be a roof face, roof, Roof Style, or the Roof Preferences.	オブジェクトのハンドル（屋根、屋根スタイルまたは、屋根設定）
componentIndex	The index of the component.	構成要素の番号
wallAssociatedModification	Returns the wall associated modification of the component. 0 - None 1 - Clip walls 2 - Clipped by walls	壁結合時の端部の調整

See Also:

SetCompWallAssMod  

VectorScript Declaration:

FUNCTION   GetCoreWallComponent

( object:HANDLE ) :INTEGER ;

Python:

def  vs.GetCoreWallComponent(object):

   return INTEGER

Description:

Gets the core wall component of an object.

説明

壁の構成要素の中のコア指定されている番号を返します。

Parameters:

object

The object. Can be a wall, round wall, Wall Style, or the Wall Preferences.

オブジェクトのハンドル（壁、円弧壁、壁スタイルまたは、壁設定）

Result:

The index of the core wall component. If it is 0, there is no core wall component.

返り値

The index of the core wall component. If it is 0, there is no core wall component.

See Also:

SetCoreWallComponent  

VectorScript Declaration:

FUNCTION   GetDatumRoofComp

( object:HANDLE ) :INTEGER ;

Python:

def  vs.GetDatumRoofComp(object):

   return INTEGER

Description:

Gets the datum roof component of the object.

説明

図形の構成要素の屋根基準面を取得します。

Parameters:

object

The object. Can be a roof face, roof, Roof Style, or the Roof Preferences.

オブジェクトのハンドル（屋根、屋根スタイルまたは、屋根設定）

Result:

The index of the datum roof component.

返り値

屋根基準面の番号

See Also:

SetDatumRoofComp  

VectorScript Declaration:

FUNCTION   GetDatumSlabComponent

( object:HANDLE ) :INTEGER ;

Python:

def  vs.GetDatumSlabComponent(object):

   return INTEGER

Description:

Gets the datum slab component of an object.

説明

図形の構成要素のスラブ基準面を取得します。

Parameters:

object

The object. Can be a slab, Slab Style, or the Slab Preferences.

オブジェクトのハンドル（スラブ、スラブスタイルまたは、スラブ設定）

Result:

The index of the datum slab component.

返り値

スラブ基準面構成要素のインデックス。

See Also:

SetDatumSlabComponent  

VectorScript Declaration:

FUNCTION   GetDefGenStoryBound

(   format :HANDLE;   VAR  boundType :INTEGER;   VAR  boundStory :INTEGER;   VAR  layerLevelType :STRING;   VAR  offset :REAL ) :BOOLEAN ;

Python:

def  vs.GetDefGenStoryBound(format):

   return (BOOLEAN, boundType, boundStory, layerLevelType, offset)

Description:

This will get the default story bound for a plugin that has the kObjXPropSupportGenericStoryLevel property.
The bound information returned is only valid when the return value of the function is TRUE.

説明

kObjXPropSupportGenericStoryLevelプロパティを持つプラグインオブジェクトのデフォルトのストーリ高さ基準情報を取得します。
取得した高さ情報は関数の戻り値がTRUEのときのみ有効です。

Parameters:

format	Handle of the parametric's format	プラグインオブジェクト定義のレコードフォーマット
boundType	Bounding type: 0 - LayerZ; 1 - DefaultWallHeight; 2 - Story	高さ基準のタイプ: 0 - レイヤの高さ; 1 - 壁の高さ; 2 - ストーリ
boundStory	The story for the bound. If 'boundStory' = 0 then it is the object's story. If 'boundStory' = 1 then it is the story above. If 'boundStory' = -1 then it is the story below.	高さを参照するストーリ: 0 - 図形のストーリ; 1 - 上のストーリ; -1 - 下のストーリ
layerLevelType	The layer type which defines this bound (e.g. "Ceiling").	ストーリレベル
offset	The offset distance from the specified bound story.	高さオフセット

Result:

Returns TRUE if the default bounds were obtained; FALSE if the input format was not a format associated with a plugin that supports the generic PIO bound (i.e. has the kObjXPropSupportGenericStoryLevel property set).

返り値

デフォルトの高さを取得できた場合TRUEを返します。 プラグインに高さ基準情報をサポートするフォーマット(kObjXPropSupportGenericStoryLevel)が関連付けられていなかった場合FALSEを返します。

VectorScript Declaration:

FUNCTION   GetInsertLocComp

( object:HANDLE ) :INTEGER ;

Python:

def  vs.GetInsertLocComp(object):

   return INTEGER

Description:

Gets the insert location component of the object.

説明

オブジェクトの挿入位置の構成要素を取得します。

Parameters:

object

The object. Can be a wall, Wall Style, or the Wall Preferences.

指定するオブジェクト（壁、壁スタイル、または壁設定）

Result:

The index of the insert location component.

返り値

挿入位置構成要素のインデックス

See Also:

SetInsertLocComp  

VectorScript Declaration:

FUNCTION   GetNumberOfComponents

(   object :HANDLE;   VAR  numComponents :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetNumberOfComponents(object):

   return (BOOLEAN, numComponents)

Description:

Gets the number of components in an object.

説明

ハンドルで指定した壁の構成要素の数を取得します。
ハンドルがNILならば、デフォルト壁スタイルに作用します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
numComponents	Returns the number of components.	構成要素の数

VectorScript Declaration:

FUNCTION   GetObjBoundElevation

(   object :HANDLE;     boundID :INTEGER ) :REAL ;

Python:

def  vs.GetObjBoundElevation(object, boundID):

   return REAL

Description:

Get the elevation of the specified bound ID relative to the object's layer.

説明

指定した図形のあるレイヤの高さ基準の値を返します。

Parameters:

object	The object.	図形のハンドル
boundID	The identifier of the story bound.	高さ基準の識別子

Result:

Return the elevation of the specified bound ID relative to the object's layer.

返り値

指定した図形のあるレイヤの高さ基準の値を返します。

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

VectorScript Declaration:

FUNCTION   GetObjStoryBound

(   object :HANDLE;     boundID :INTEGER;   VAR  boundType :INTEGER;   VAR  boundStory :INTEGER;   VAR  layerLevelType :STRING;   VAR  offset :REAL ) :BOOLEAN ;

Python:

def  vs.GetObjStoryBound(object, boundID):

   return (BOOLEAN, boundType, boundStory, layerLevelType, offset)

Description:

Get the data of the specified story bound of this object.

説明

ハンドルで指定した図形の高さ基準に関するデータを返します。

Parameters:

object	The object.	図形のハンドル
boundID	The identifier of the story bound.	高さ基準の識別子
boundType	Bounding type: 0 - DefaultWallHeight; 1 - LayerZ; 2 - Story	高さ基準のタイプ : 0 - デフォルトの壁の高さ; 1 - レイヤ高さ Z; 2 - 高さ基準
boundStory	The story identified by 'boundType' = (2 - Story). If 'boundStory' = 0 then it is this story (the object's story); If 'boundStory' = 1 then it is the story above; If 'boundStory' = -1 then it is the story below.	高さ基準のタイプ boundType = 2 の場合、0 : 図形の高さ基準; 1 : 上のストーリ; -1 : 下のストーリ
layerLevelType	The layer type which defines this bound	レベルタイプ
offset	The offset distance from the specified bound story	オフセット

Result:

Return TRUE if the operation is successful.

返り値

正常終了するとTRUEが返されます。

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

VectorScript Declaration:

FUNCTION   GetObjStoryBoundsAt

(   object :HANDLE;     index :INTEGER ) :INTEGER ;

Python:

def  vs.GetObjStoryBoundsAt(object, index):

   return INTEGER

Description:

Return the story bound ID of the specified story bound index. The index is between 1 and the result of GetObjStoryBoundsCnt.

説明

ハンドルで指定した図形の高さ基準に関するデータを返します。

Parameters:

object	The object.	図形のハンドル
index	Index of the story bound which ID will be returned. This index should be between 1 and the result of GetObjStoryBoundsCnt.	高さ基準の識別子

Result:

Return the story bound ID.

返り値

高さ基準番号を返します。

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

VectorScript Declaration:

FUNCTION   GetObjStoryBoundsCnt

( object:HANDLE ) :INTEGER ;

Python:

def  vs.GetObjStoryBoundsCnt(object):

   return INTEGER

Description:

Return the number of story bounds defined for this object.

説明

ハンドルで指定した図形に定義されたの高さ基準の個数を返します。

Parameters:

object

The object.

オブジェクトのハンドル

Result:

The number of story bounds for this object.

返り値

定義されたの高さ基準の個数

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

VectorScript Declaration:

FUNCTION   GetRoofPreferences

:HANDLE ;

Python:

def  vs.GetRoofPreferences():

   return HANDLE

Description:

Gets the Roof Preferences. This can be used with the component calls and the Style selectors.

説明

屋根の設定を取得します。これは構成要素関連のコールやスタイル選択と共に使用することができます。

Result:

The Roof Preferences.

返り値

屋根の設定のハンドル

VectorScript Declaration:

FUNCTION   GetRoofPrefStyle

:LONGINT ;

Python:

def  vs.GetRoofPrefStyle():

   return LONGINT

Description:

Gets the Roof Style of the Roof Preferences.

説明

屋根の設定の屋根スタイルを取得します。

Result:

The ref number of the Roof Style of the Roof Preferences. 0 for unstyled.

返り値

屋根設定の屋根スタイルの参照番号。スタイルなしの場合は0

See Also:

SetRoofPrefStyle  

VectorScript Declaration:

FUNCTION   GetSlabHeight

( slab:HANDLE ) :REAL ;

Python:

def  vs.GetSlabHeight(slab):

   return REAL

Description:

Gets the height of a slab.

説明

スラブの高さを取得します。

Parameters:

slab

The slab.

スラブ

Result:

The height of the slab.

返り値

スラブの高さ

See Also:

SetSlabHeight  

VectorScript Declaration:

FUNCTION   GetSlabPreferences

:HANDLE ;

Python:

def  vs.GetSlabPreferences():

   return HANDLE

Description:

Gets the Slab Preferences. This can be used with the component calls and the Style selectors.

説明

スラブ設定を取得します。構成要素関連のコールやスタイルの選択とあわせて使用します。

Result:

The Slab Preferences.

返り値

スラブ設定

VectorScript Declaration:

FUNCTION   GetSlabPreferencesStyle

:LONGINT ;

Python:

def  vs.GetSlabPreferencesStyle():

   return LONGINT

Description:

Gets the Slab Style of the Slab Preferences.

説明

スラブ設定のスラブスタイルを取得します。

Result:

The ref number of the Slab Style of the Slab Preferences. 0 for unstyled.

返り値

スラブ設定のスラブスタイルの参照番号。スタイルなしの場合は0

See Also:

SetSlabPreferencesStyle  

VectorScript Declaration:

FUNCTION   GetSlabStyle

( slab:HANDLE ) :LONGINT ;

Python:

def  vs.GetSlabStyle(slab):

   return LONGINT

Description:

Gets the Slab Style of a slab.

説明

スラブのスラブスタイルを取得します。

Parameters:

slab

The slab.

スラブ

Result:

The ref number of the Slab Style of the slab. 0 for unstyled.

返り値

スラブのスラブスタイルの参照番号。スタイルなしの場合は0

See Also:

SetSlabStyle  

VectorScript Declaration:

FUNCTION   GetStoryLayerInfo

(   index :INTEGER;   VAR  name :STRING;   VAR  scaleFactor :REAL;   VAR  layerLevelType :STRING;   VAR  eleveationOffset :REAL;   VAR  defaultWallHeight :REAL ) :Boolean ;

Python:

def  vs.GetStoryLayerInfo(index):

   return (Boolean, name, scaleFactor, layerLevelType, eleveationOffset, defaultWallHeight)

Description:

Returns information on the given story layer template

説明

インデックスを使用して、ストーリの情報を返します。

Parameters:

index	Index of story.	参照番号
name	Returns with Name of story layer template	名前
scaleFactor	Returns with Scale Factor of story layer template	スケール
layerLevelType	Returns with Level Type of story layer template	レベルタイプ
eleveationOffset	Returns with the Elevation Offset of story layer template	高さオフセット
defaultWallHeight	Returns with the Default Wall Height of story layer template	壁の高さ

Result:

Boolean - TRUE if the story at given index was found, FALSE if no story was found at the given index.

返り値

存在しない場合、FALSEを返します。

VectorScript Declaration:

FUNCTION   GetTaperedComponent

( object:HANDLE ) :INTEGER ;

Python:

def  vs.GetTaperedComponent(object):

   return INTEGER

Description:

Gets the tapered component of the object.

説明

テーパが設定されている構成要素のインデックスを取得します。

Parameters:

object

The object. Can be a slab, Slab Style, or the Slab Preferences.

オブジェクトのハンドル（スラブ、スラブスタイル、スラブ設定）

Result:

The index of the tapered component.

返り値

テーパが設定されている構成要素のインデックス

See Also:

SetTaperedComponent  

VectorScript Declaration:

FUNCTION   GetWallPreferences

:HANDLE ;

Python:

def  vs.GetWallPreferences():

   return HANDLE

Description:

Gets the Wall Preferences. This can be used with the component calls and the Style selectors.

説明

壁設定を取得します。これは構成要素の関数やスタイル選択に使えます。

Result:

The Wall Preferences.

返り値

壁設定

VectorScript Declaration:

FUNCTION   HasObjStoryBound

(   object :HANDLE;     boundID :INTEGER ) :BOOLEAN ;

Python:

def  vs.HasObjStoryBound(object, boundID):

   return BOOLEAN

Description:

Determine if the object has the specified story bound ID present.

説明

ハンドルで指定した図形が高さ基準を持つ図形であるかを返します。

Parameters:

object	The object.	図形のハンドル
boundID	The identifier of the story bound.	識別子

Result:

Retrun TRUE if the story bound ID is present. Otherwise - FALSE.

返り値

高さ基準を持つ図形である場合、TRUEを返します。

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

VectorScript Declaration:

FUNCTION   HasObjStoryBounds

( object:HANDLE ) :BOOLEAN ;

Python:

def  vs.HasObjStoryBounds(object):

   return BOOLEAN

Description:

Determine if the object has any story bounds.

説明

ハンドルで指定した図形が高さ基準を持つ図形であるかを返します。

Parameters:

object

The object.

図形のハンドル

Result:

Return TRUE if the object has any story bounds. Otherwise - FALSE.

返り値

高さ基準を持つ図形である場合、TRUEを返します。

See Also:

HasObjStoryBounds   HasObjStoryBound   GetObjStoryBound   SetObjectStoryBound   DelObjStoryBounds   DelObjStoryBound   GetObjStoryBoundsCnt   GetObjStoryBoundsAt  

VectorScript Declaration:

FUNCTION   InsertNewComponent

(   object :HANDLE;     beforeComponentIndex :INTEGER;     width :REAL (Coordinate);     fill :LONGINT;     leftPenWeight :INTEGER;     rightPenWeight :INTEGER;     leftPenStyle :INTEGER;     rightPenStyle :INTEGER ) :BOOLEAN ;

Python:

def  vs.InsertNewComponent(object, beforeComponentIndex, width, fill, leftPenWeight, rightPenWeight, leftPenStyle, rightPenStyle):

   return BOOLEAN

Special Notes:

InsertNewComponent is obsolete as of Vectorworks 2014

Description:

Deprecated - will generate error. Use InsertNewComponentN instead.

説明

ハンドルで指定した壁で、指定した番号の構成要素の前に、新しい構成要素を追加します。
ハンドルがNILならば、デフォルト壁スタイルに作用します。

Parameters:

object	The object. Can be a wall, round wall, slab, roof face, roof, Wall Style, Slab Style, Roof Style, the Wall Preferences, the Slab Preferences, or the Roof Preferences.	オブジェクトのハンドル（壁、円弧壁、スラブ、屋根、壁スタイル、スラブスタイル、屋根スタイル、壁設定、スラブ設定もしくは、屋根設定）
beforeComponentIndex	The index before which to insert the new component.	構成要素の番号
width	The width of the component.	構成要素の幅
fill	The fill of the component. Positive values for patterns, negative ref numbers for hatches.	構成要素の面 模様は正の値、ハッチングは負の値で指定します。
leftPenWeight	The pen weight of the component's left line.	構成要素の左側の線の太さ
rightPenWeight	The pen weight of the component's right line.	構成要素の右側の線の太さ
leftPenStyle	The pen style of the component's left line. Positive values for patterns, negative values for dash styles.	構成要素の左側の線の種類 破線の種類は負の値で指定します。
rightPenStyle	The pen style of the component's right line. Positive values for patterns, negative values for dash styles.	構成要素の右側の線の種類 破線の種類は負の値で指定します。

See Also:

InsertNewComponentN