AddVPAnnotationObject Objects - Groups 
VectorWorks11.0

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.



  BeginGroup Objects - Groups 
MiniCAD

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.

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}



  BeginGroupN Objects - Groups 
Vectorworks 2011

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.

Parameters:

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

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  



  CreateVP Objects - Groups 
VectorWorks11.0

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.



  EndGroup Objects - Groups 
MiniCAD

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.

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}



  GetVPClassVisibility Objects - Groups 
VectorWorks11.0

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.



  GetVPCropObject Objects - Groups 
VectorWorks11.0

VectorScript Declaration:

FUNCTION   GetVPCropObject
( viewportHandle:HANDLE ) :HANDLE ;

Python:

def  vs.GetVPCropObject(viewportHandle):
   return HANDLE

Description:

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



  GetVPGroup Objects - Groups 
VectorWorks11.0

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



  GetVPGroupParent Objects - Groups 
VectorWorks11.0

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.



  GetVPLayerVisibility Objects - Groups 
VectorWorks11.0

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.



  Group Objects - Groups 
MiniCAD

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}





  GroupToMesh Objects - Groups 
VectorWorks10.0

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  



  HUngroup Objects - Groups 
VectorWorks8.5

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.



  IsVPGroupContainedObject Objects - Groups 
VectorWorks11.0

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)

Result:

true if object is contained within a viewport group



  SetVPClassVisibility Objects - Groups 
VectorWorks11.0

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.



  SetVPCropObject Objects - Groups 
VectorWorks11.0

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.



  SetVPLayerVisibility Objects - Groups 
VectorWorks11.0

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.



  Ungroup Objects - Groups 
MiniCAD

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.





  UpdateVP Objects - Groups 
VectorWorks11.0

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



  VPHasCropObject Objects - Groups 
VectorWorks11.0

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.