VectorScript Declaration:

FUNCTION   AddVPAnnotationObject

(   viewportHandle :HANDLE;     annotationHandle :HANDLE ) :BOOLEAN ;

Python:

def  vs.AddVPAnnotationObject(viewportHandle, annotationHandle):

   return BOOLEAN

Description:

Adds the specified annotation object to the specified viewport.

説明

指定したビューポートに指定した注釈を追加します。

VectorScript Declaration:

PROCEDURE   BeginGroup

;

Python:

def  vs.BeginGroup():

   return None

Description:

Procedure BeginGroup creates a new group object in a Vectorworks document. Procedure calls subsequent to BeginGroup and before EndGroup will be included in the new group object. BeginGroup may be called repeatedly to created nested groups of objects.

説明

この手続きを実行した後、EndGroupが実行されるまでの間に作成された図形をグループ化します。

Example:

BeginGroup;
  Rect(-1,1,0.5,0);
  Rect(0,1.5,1,0.5);
  Oval(-1.5,0.5,-0.5,-0.5);
EndGroup;
{creates a group}

BeginGroup;
  Rect(-1,1,0,0.5);
  Rect(-1,0.5,-0.5,0);
  BeginGroup;
    Oval(-0.5,0.5,1,0);
    Oval(0,0,1,-0.5);
  EndGroup;
EndGroup;
{creates a group comprised of 2 rects and 1 group}

VectorScript Declaration:

PROCEDURE   BeginGroupN

( VAR groupHandle:HANDLE ) ;

Python:

def  vs.BeginGroupN(groupHandle):

   return groupHandle

Description:

May be used to create objects in an existing group by passing a group handle; if a handle initialized to nil is passed a new group is created.

説明

グループのハンドルを指定し、既存のグループに図形を作成して追加します。nilに初期化されたハンドルを渡した場合は新しいグループが作成されます。

Parameters:

groupHandle

The group handle to be used; if handle is initialized to nil a new group is created.

対象となるグループのハンドル。ハンドルがnilに初期化されている場合は新しいグループが作られます。

Example:

BeginGroupN(groupHandle);
  Rect(-1,1,0.5,0);
EndGroup;
{ adds created rect to existing group }

groupHandle := nil;
BeginGroupN(groupHandle);
  Rect(-1,1,0.5,0);
EndGroup;
{ creates new group and adds created rect to created group }

See Also:

BeginGroup   EndGroup  

VectorScript Declaration:

FUNCTION   CreateVP

( parentHandle:HANDLE ) :HANDLE ;

Python:

def  vs.CreateVP(parentHandle):

   return HANDLE

Description:

Creates a viewport object. The specified parent handle may only be a layer or a group contained within a layer, nested or otherwise.

説明

ビューポートを作成します。表示されているレイヤや、表示されているレイヤの中にあるグループのハンドルをコンテナのハンドルとして渡します。

VectorScript Declaration:

PROCEDURE   EndGroup

;

Python:

def  vs.EndGroup():

   return None

Description:

Procedure EndGroup completes the creation of a new group object in a Vectorworks document. The new group object is then generated in the document.

説明

BeginGroupを実行した後、この手続きを実行するまでの間に作成された図形をグループ化します。

Example:

BeginGroup;
Rect(-1,1,0.5,0);
Rect(0,1.5,1,0.5);
Oval(-1.5,0.5,-0.5,-0.5);
EndGroup;
{creates a group object}

BeginGroup;
Rect(-1,1,0,0.5);
Rect(-1,0.5,-0.5,0);
BeginGroup;
Oval(-0.5,0.5,1,0);
Oval(0,0,1,-0.5);
EndGroup;
EndGroup;
{creates a group comprised of 2 rects and 1 group}

VectorScript Declaration:

FUNCTION   GetVPClassVisibility

(   viewportHandle :HANDLE;     className :STRING;   VAR  visibilityType :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetVPClassVisibility(viewportHandle, className):

   return (BOOLEAN, visibilityType)

Description:

Gets the visibility for the specified class in the specified viewport.

説明

指定したビューポートの指定したクラスの表示形式を返します。

VectorScript Declaration:

FUNCTION   GetVPCropObject

( viewportHandle:HANDLE ) :HANDLE ;

Python:

def  vs.GetVPCropObject(viewportHandle):

   return HANDLE

Description:

Gets the specified viewport's crop object, if any.

説明

指定したビューポートの枠のハンドルを返します。

VectorScript Declaration:

FUNCTION   GetVPGroup

(   viewportHandle :HANDLE;     groupType :INTEGER ) :HANDLE ;

Python:

def  vs.GetVPGroup(viewportHandle, groupType):

   return HANDLE

Description:

Gets the specified viewport group.

groupType values:
Crop = 1
Annotation = 2
Cache = 3

説明

指定したビューポートのグループの種類を返します。
グループの種類（1：枠／2：注釈／3：キャッシュ）

VectorScript Declaration:

FUNCTION   GetVPGroupParent

( groupHandle:HANDLE ) :HANDLE ;

Python:

def  vs.GetVPGroupParent(groupHandle):

   return HANDLE

Description:

Gets the viewport that is the parent of specified viewport group.

説明

指定したビューポートグループのコンテナである、ビューポートのハンドルを返します。

Parameters:

groupHandle

handle to a viewport group (crop, annotation, etc)

ビューポートグループ内の図形のハンドル（枠、注釈など）

Result:

Returns a handle to the viewport object (type 122) that is the parent of the specified group, or nil if unsuccessful.

返り値

指定したビューポートグループのコンテナであるビューポート（図形番号122）のハンドルを返します。成功しなかった場合は、NILを返します。

VectorScript Declaration:

FUNCTION   GetVPLayerVisibility

(   viewportHandle :HANDLE;     layerHandle :HANDLE;   VAR  visibilityType :INTEGER ) :BOOLEAN ;

Python:

def  vs.GetVPLayerVisibility(viewportHandle, layerHandle):

   return (BOOLEAN, visibilityType)

Description:

Gets the visibility for the specified layer in the specified viewport.

説明

指定したビューポートの指定したレイヤの表示形式を返します。

VectorScript Declaration:

PROCEDURE   Group

;

Python:

def  vs.Group():

   return None

Description:

Procedures Group groups selected objects in a Vectorworks document. Any selected objects on the active layer(or any selected objects in the document when in Show-Snap-Modify mode) will be included in the new group object.

説明

アクティブなレイヤ上の選択されている図形をグループ化します。

Example:

Rect(-1,1,0,0);
Rect(-1,-0.5,0,-1.5);
Group;
{groups the most recently created objects}

VectorScript Declaration:

FUNCTION   GroupToMesh

( groupObj:HANDLE ) :HANDLE ;

Python:

def  vs.GroupToMesh(groupObj):

   return HANDLE

Description:

Converts a group of 3D polygons into a mesh network.

説明

ハンドルで指定したグループ図形をメッシュ図形に変換します。

Parameters:

groupObj

Handle to a group containing 3D polygons

グループ図形のハンドル

Result:

Returns a handle to the mesh network.

返り値

メッシュ図形のハンドルを返します。

See Also:

MeshToGroup  

VectorScript Declaration:

PROCEDURE   HUngroup

( h:HANDLE ) ;

Python:

def  vs.HUngroup(h):

   return None

Description:

Decomposes the referenced group into component objects.

説明

ハンドルで指定した図形をグループ解除します。

Parameters:

h

Handle to group.

グループ図形のハンドル

VectorScript Declaration:

FUNCTION   IsVPGroupContainedObject

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

Python:

def  vs.IsVPGroupContainedObject(objectHandle, groupType):

   return BOOLEAN

Description:

Determines if specified object is contained within a viewport group, and if so which type of group.

説明

指定した図形がビューポートグループに含まれている／いないを返します。

Parameters:

objectHandle	Handle to object	図形のハンドル
groupType	Type of group containing the object: (1 = Crop, 2 = Annotation, 3 = Cache, 4 = Section)	図形の種類（1：枠／2：注釈／3：キャッシュ／4：断面）

Result:

true if object is contained within a viewport group

返り値

TRUE：図形はビューポートグループに含まれています。
FALSE：図形はビューポートグループに含まれていません。

VectorScript Declaration:

FUNCTION   SetVPClassVisibility

(   viewportHandle :HANDLE;     className :STRING;     visibilityType :INTEGER ) :BOOLEAN ;

Python:

def  vs.SetVPClassVisibility(viewportHandle, className, visibilityType):

   return BOOLEAN

Description:

Sets the visibility for the specified class in the specified viewport.

説明

指定したビューポートの指定したクラスの表示形式を設定します。

VectorScript Declaration:

FUNCTION   SetVPCropObject

(   viewportHandle :HANDLE;     cropHandle :HANDLE ) :BOOLEAN ;

Python:

def  vs.SetVPCropObject(viewportHandle, cropHandle):

   return BOOLEAN

Description:

Sets the specified crop object in the specified viewport. If a crop object already exists, it will be replaced by the new object, so long as the new object is a valid crop.

説明

指定したビューポートに指定した枠を設定します。新しい図形が枠図形として有効であれば、置き換えられます。

VectorScript Declaration:

FUNCTION   SetVPLayerVisibility

(   viewportHandle :HANDLE;     layerHandle :HANDLE;     visibilityType :INTEGER ) :BOOLEAN ;

Python:

def  vs.SetVPLayerVisibility(viewportHandle, layerHandle, visibilityType):

   return BOOLEAN

Description:

Sets the visibility for the specified layer in the specified viewport.

説明

指定したビューポートの指定したレイヤの表示形式を設定します。

VectorScript Declaration:

PROCEDURE   Ungroup

;

Python:

def  vs.Ungroup():

   return None

Description:

Procedure Ungroup ungroups selected objects in a Vectorworks document.When Ungroup is called, any selected group objects will be destroyed, reverting to the original component objects.

説明

アクティブなレイヤ上の選択されている図形をグループ解除します。

VectorScript Declaration:

PROCEDURE   UpdateVP

( viewportHandle:HANDLE ) ;

Python:

def  vs.UpdateVP(viewportHandle):

   return None

Description:

Updates the specified viewport: a dirty viewport, whose render type is other than wireframe, will be re-rendered.

説明

指定したビューポートを更新します。ワイヤーフレームレンダリング以外は再度レンダリングが行われます。

Parameters:

viewportHandle

Handle to a viewport

ビューポートのハンドル

VectorScript Declaration:

FUNCTION   VPHasCropObject

( viewportHandle:HANDLE ) :BOOLEAN ;

Python:

def  vs.VPHasCropObject(viewportHandle):

   return BOOLEAN

Description:

Indicates if specified viewport has a crop object.

説明

指定したビューポートに枠が含まれている／いないを返します。

Parameters:

viewportHandle

Handle to viewport.

ビューポートのハンドル