Declaration:

FUNCTION   AddVPAnnotationObject

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

Description:

Adds the specified annotation object to the specified viewport.

Declaration:

PROCEDURE   BeginGroup

;

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.

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}

Declaration:

FUNCTION   CreateVP

( parentHandle:HANDLE ) :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.

Declaration:

PROCEDURE   EndGroup

;

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.

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}

Declaration:

FUNCTION   GetVPClassVisibility

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

Description:

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

Declaration:

FUNCTION   GetVPCropObject

( viewportHandle:HANDLE ) :HANDLE ;

Description:

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

Declaration:

FUNCTION   GetVPGroup

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

Description:

Gets the specified viewport group.

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

Declaration:

FUNCTION   GetVPGroupParent

( groupHandle:HANDLE ) :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.

Declaration:

FUNCTION   GetVPLayerVisibility

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

Description:

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

Declaration:

PROCEDURE   Group

;

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}

Declaration:

FUNCTION   GroupToMesh

( groupObj:HANDLE ) :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  

Declaration:

PROCEDURE   HUngroup

( h:HANDLE ) ;

Description:

Decomposes the referenced group into component objects.

Parameters:

h	Handle to group.

Declaration:

FUNCTION   IsVPGroupContainedObject

(   objectHandle :HANDLE;     groupType :INTEGER ) :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)

Result:

true if object is contained within a viewport group

Declaration:

FUNCTION   SetVPClassVisibility

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

Description:

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

Declaration:

FUNCTION   SetVPCropObject

(   viewportHandle :HANDLE;     cropHandle :HANDLE ) :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.

Declaration:

FUNCTION   SetVPLayerVisibility

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

Description:

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

Declaration:

PROCEDURE   Ungroup

;

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.

Declaration:

PROCEDURE   UpdateVP

( viewportHandle:HANDLE ) ;

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

Declaration:

FUNCTION   VPHasCropObject

( viewportHandle:HANDLE ) :BOOLEAN ;

Description:

Indicates if specified viewport has a crop object.

Parameters:

viewportHandle

Handle to viewport.