VS:BeginRoof

From Vectorworks Developer
Revision as of 14:25, 12 August 2013 by Root (talk | contribs) (1 revision)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Procedure BeginRoof creates a simple roof object in a VectorWorks document.

Table - Roof Miter Styles
Miter Style Constant
Vertical 1
Horizontal 2
Double 3
Square 4
  • 3-D View of Roof

PROCEDURE BeginRoof(
p1X,p1Y :REAL;
p2X,p2Y :REAL;
upslopeX,upslopeY :REAL;
riseDistance :REAL;
runDistance :REAL;
miter :INTEGER;
vertPart :REAL);
def vs.BeginRoof(p1, p2, upslope, riseDistance, runDistance, miter, vertPart):
    return None

Parameters

p1 REAL Coordinates of roof axis start point.
p2 REAL Coordinates of roof axis end point.
upslope REAL Coordinates of upslope definition point.
riseDistance REAL Rise distance.
runDistance REAL Run distance.
miter INTEGER Edge miter style of roof.
vertPart REAL Dimension of vertical miter for double miter style.

Example

VectorScript

BeginRoof(1,1,5,1,2,2,0.5,1,1,0);
ClosePoly;
Poly(1,1,3,1,3.5,2,4,1,5,1,5,5,1,5);
EndGroup;

Python

vs.BeginRoof(1,1,5,1,2,2,0.5,1,1,0)
vs.ClosePoly()
vs.Poly(1,1,3,1,3.5,2,4,1,5,1,5,5,1,5)
vs.EndGroup()

Version

Availability: from MiniCAD 4.0