AlignDistribute2D General Edit 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   AlignDistribute2D
(   MenuAction :LONGINT;
    AlignDist2DParms :LONGINT
) ;

Python:

def  vs.AlignDistribute2D(MenuAction, AlignDist2DParms):
   return None

Description:

2D Object Alignment/Distribution



  AlignDistribute3D General Edit 
Vectorworks 2014

VectorScript Declaration:

PROCEDURE   AlignDistribute3D
(   MenuAction :LONGINT;
    AlignDist3DParms :LONGINT
) ;

Python:

def  vs.AlignDistribute3D(MenuAction, AlignDist3DParms):
   return None

Description:

3D Object Alignment/Distribution



  Backward General Edit 
MiniCAD

VectorScript Declaration:

PROCEDURE   Backward
;

Python:

def  vs.Backward():
   return None

Description:

Procedure Backward moves the selected objects down one level in the onscreen object stacking order.



  CreateScriptResource General Edit 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   CreateScriptResource
(   scriptName :STRING;
    paletteName :STRING;
    paletteOpen :BOOLEAN;
    script :DYNARRAY[] of CHAR;
    python :BOOLEAN
) :BOOLEAN ;

Python:

def  vs.CreateScriptResource(scriptName, paletteName, paletteOpen, script, python):
   return BOOLEAN

Description:

Create a document script resource.

Parameters:

scriptName A unique name for the new document script.
paletteName A name of the script palette that will contain the new script. If the script palette doesn't exist, it will be created.
paletteOpen Pass in TRUE if the script palette should be opened when created, and FALSE if it should be closed. If the palette exist, this parameter has no effect.
script The script text.
python Pass TRUE if the script text contains python script. Otherwise it will be considered VectorScript.

Result:

Return TRUE if the creation was successful. The routine will fail if script with the specified name already exist.

See Also:

GetScriptResource   SetScriptResource   OpenScriptResPal  



  FlipHor General Edit 
MiniCAD

VectorScript Declaration:

PROCEDURE   FlipHor
;

Python:

def  vs.FlipHor():
   return None

Description:

Procedure FlipHor horizontally mirrors selected objects about the center of the object(s). This procedure produces the same effect as the command 'Flip Horizontal' .




  FlipVer General Edit 
MiniCAD

VectorScript Declaration:

PROCEDURE   FlipVer
;

Python:

def  vs.FlipVer():
   return None

Description:

Procedure FlipVer vertically mirrors selected objects about the center of the
object(s). This procedure produce the same effect as the command 'Flip Vertical'.



  Forward General Edit 
MiniCAD

VectorScript Declaration:

PROCEDURE   Forward
;

Python:

def  vs.Forward():
   return None

Description:

Procedure Forward moves the selected objects up one level in the onscreen object stacking order.

Objects in the document are drawn in the order in which they are created, with newer objects drawn on top of previously created objects. It is sometimes necessary to adjust this drawing, or stacking, order in order to make objects visible or create a desired effect.




See Also:

HMoveForward  



  GetScriptResource General Edit 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   GetScriptResource
(   scriptName :STRING;
  VAR  script :DYNARRAY[] of CHAR;
  VAR  python :BOOLEAN
) :BOOLEAN ;

Python:

def  vs.GetScriptResource(scriptName):
   return (BOOLEAN, script, python)

Description:

Return the script text of the specified script resource.

Parameters:

scriptName The script name identifying the resource.
script Return the script text.
python Return if the script text is a python script.

Result:

Return TRUE if the creation was successful. The routine will fail if script with the specified name does't exist.

See Also:

CreateScriptResource   SetScriptResource   OpenScriptResPal  



  LckObjs General Edit 
MiniCAD

VectorScript Declaration:

PROCEDURE   LckObjs
;

Python:

def  vs.LckObjs():
   return None

Description:

Procedure LckObjs locks the selected objects. When an object is locked, it
may be copied or duplicated, but it may not be changed in any other way.


Example:

SelectObj((C='Structure To Remain'));
LckObjs;



  MirrorXY3D General Edit 
MiniCAD5.0.2

VectorScript Declaration:

PROCEDURE   MirrorXY3D
;

Python:

def  vs.MirrorXY3D():
   return None

Description:

Procedure MirrorXY3D mirrors the currently selected object through the XY plane.



  MoveBack General Edit 
MiniCAD

VectorScript Declaration:

PROCEDURE   MoveBack
;

Python:

def  vs.MoveBack():
   return None

Description:

Procedure MoveBack moves the selected objects to the back (bottom) of the onscreen object stacking order.




  MoveFront General Edit 
MiniCAD

VectorScript Declaration:

PROCEDURE   MoveFront
;

Python:

def  vs.MoveFront():
   return None

Description:

Procedure MoveFront moves the selected objects to the front (top) of the onscreen object stacking order.



  ResetOrientation3D General Edit 
MiniCAD5.0.2

VectorScript Declaration:

PROCEDURE   ResetOrientation3D
;

Python:

def  vs.ResetOrientation3D():
   return None

Description:

ResetOrientation3D resets the 3D environment parameters of the active Vectorworks document.

Call this procedure after 3D object creation to ensure correct orientation and display of the new object in 3D space.

Example:

Poly3D(1,1,0,1.5,1.5,1,2.5,1.5,1,);
ResetOrientation3D;



  Rotate General Edit 
MiniCAD

VectorScript Declaration:

PROCEDURE   Rotate
( rotationAngle:REAL ) ;

Python:

def  vs.Rotate(rotationAngle):
   return None

Description:

Procedure Rotate rotates the currently selected objects on the active layer. The rotation angle may be specified in any valid angle format. When a locus is selected with a group of objects, the objects are rotated around the locus. If two or more loci are selected, the objects are rotated around the center of the selected objects.

Parameters:

rotationAngle Rotation angle.

Example:

Rotate(45d15'23");



  Rotate3D General Edit 
MiniCAD

VectorScript Declaration:

PROCEDURE   Rotate3D
(   xAngle :REAL;
    yAngle :REAL;
    zAngle :REAL
) ;

Python:

def  vs.Rotate3D(xAngle, yAngle, zAngle):
   return None

Description:

Procedure Rotate3D rotates the most recently created three-dimensional object. Rotation values are applied about the respective axes.

Parameters:

xAngle Rotation about X-axis.
yAngle Rotation about Y-axis
zAngle Rotation about Z-axis.

Example:

BeginXtrd(0",4");
Rect(0",3",1",0");
EndXtrd;
Rotate3D(21d 10' 22",-18d 44' 50",-7d 5' 45");



  RotatePoint General Edit 
MiniCAD6.0

VectorScript Declaration:

PROCEDURE   RotatePoint
(   pX :REAL;
    pY :REAL;
    rotationAngle :REAL
) ;

Python:

def  vs.RotatePoint(p, rotationAngle):
   return None

Description:

Procedure RotatePoint rotates selected Vectorworks objects about the specified coordinate point.

Parameters:

p Point of rotation.
rotationAngle Rotation angle.

Example:

SetSelect(LNewObj);
RotatePoint(0,3,45d);



  Scale General Edit 
MiniCAD

VectorScript Declaration:

PROCEDURE   Scale
(   scaleXR :REAL;
    scaleYR :REAL
) ;

Python:

def  vs.Scale(scaleXR, scaleYR):
   return None

Description:

Procedure Scale rescales selected objects. Scaling occurs about the center of the selected object(s).

Parameters:

scaleXR X scale factor.
scaleYR Y scale factor.

Example:

Scale(2,3);



  SetScriptResource General Edit 
Vectorworks 2014

VectorScript Declaration:

FUNCTION   SetScriptResource
(   scriptName :STRING;
    script :DYNARRAY[] of CHAR;
    python :BOOLEAN
) :BOOLEAN ;

Python:

def  vs.SetScriptResource(scriptName, script, python):
   return BOOLEAN

Description:

Set the script text of the specified script resource.

Parameters:

scriptName The script name identifying the resource.
script The script text.
python Pass TRUE if the script text contains python script. Otherwise it will be considered VectorScript.

Result:

Return TRUE if the creation was successful. The routine will fail if script with the specified name does't exist.

See Also:

CreateScriptResource   GetScriptResource   OpenScriptResPal  



  UnLckObjs General Edit 
MiniCAD

VectorScript Declaration:

PROCEDURE   UnLckObjs
;

Python:

def  vs.UnLckObjs():
   return None

Description:

Procedure UnLckObjs unlocks the selected objects.

Example:

SelectObj((C='Structure To Remain'));
UnLckObjs;