AddCavity Objects - Architectural 

Declaration:

PROCEDURE   AddCavity
(   pair :BOOLEAN;
    leftOffDistance :REAL;
    rightOffDistance :REAL;
    pairFill :INTEGER
) ;

Description:

Procedure AddCavity creates a wall cavity in a new wall object. The newly defined cavity becomes the default for all subsequently defined walls.

Parameters:

pair Double line display mode.
leftOffDistance Left edge offset from wall centerline.
rightOffDistance Right edge offset from wall centerline.
pairFill Fill pattern index for filled cavities.

Example:

DoubLines(6");
AddCavity(True,1",2",2);
Wall(0,1,9,1);

{creates a black 1" wide cavity in the new wall object}



  AddSymToWall Objects - Architectural 

Declaration:

PROCEDURE   AddSymToWall
(   wallHd :HANDLE;
    offDistance :REAL;
    heightDistance :REAL;
    flip :BOOLEAN;
    right :BOOLEAN;
    symbolName :STRING
) ;

Description:

Procedure AddSymToWall inserts a specified symbol into the referenced wall.

Parameters:

wallHd Handle to wall.
offDistance Offset distance from wall start.
heightDistance Elevation of symbol.
flip Flipped status of symbol.
right Left-right orientation of symbol.
symbolName Name of symbol to insert in wall.

Example:

AddSymToWall(HandleToWall,3',0',FALSE,FALSE,'Door-1');

See Also:

AddSymToWallEdge  



  AddSymToWallEdge Objects - Architectural 

Declaration:

PROCEDURE   AddSymToWallEdge
(   h :HANDLE;
    alongDistance :REAL;
    heightDistance :REAL;
    flip :BOOLEAN;
    right :BOOLEAN;
    symbolName :STRING;
    insertMode :INTEGER
) ;

Description:

Procedure AddSymToWallEdge inserts a symbol in the referenced wall using the specified parameters to define placement.

Table - Symbol Insertion Alignment

Alignment Constant
Centerline 0
Left Edge 1
Right Edge 2

Parameters:

h Handle to wall.
alongDistance Offset distance from wall start of insertion point.
heightDistance Elevation of symbol.
flip Flip orientation of symbol.
right Left-right orientation of symbol.
symbolName Name of symbol to be inserted.
insertMode Edge insertion mode.



  AddWallPeak Objects - Architectural 

Declaration:

PROCEDURE   AddWallPeak
(   wallHd :HANDLE;
    offDistance :REAL;
    heightDistance :REAL
) ;

Description:

Procedure AddWallPeak creates a wall peak in the referenced wall object.

Parameters:

wallHd Handle to wall.
offDistance Offset distance from wall start.
heightDistance Elevation of wall peak.



  AppendRoofEdge Objects - Architectural 

Declaration:

PROCEDURE   AppendRoofEdge
(   object :HANDLE;
    edgePtX :REAL;
    edgePtY :REAL;
    slopeAngle :REAL;
    projectionDistance :REAL;
    eaveHeightDistance :REAL
) ;

Description:

Function AppendRoofEdge creates a new edge in the referenced roof object.

Parameters:

object Handle to roof.
edgePt Definition point of roof edge.
slopeAngle Slope of roof edge.
projectionDistance Eave overhang.
eaveHeightDistance Eave height.

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0",2'0",10'0");
shedID := CreateShedDormer(roofHandle);
SetShedAttributes(roofHandle,shedID,TRUE,6'0",10'0",2'0",#8°0'0");
SetDormerAttributes(roofHandle, shedID, 3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  BeginColumn Objects - Architectural 

Declaration:

PROCEDURE   BeginColumn
( columnDistance:REAL ) ;

Description:

Procedure BeginColumn creates a column object in a VectorWorks document using 2D object creation procedure calls to define the "template" for the column object.

After specifying object procedure calls to define the column, you should call EndGroup to complete the column definition and create the actual object.


Parameters:

columnDistance Height of column.

Example:

BeginColumn(12');
  Oval(2',2',6',6');
EndGroup;



  BeginFloor Objects - Architectural 

Declaration:

PROCEDURE   BeginFloor
( thicknessDistance:REAL ) ;

Description:

Procedure BeginFloor creates a new floor object in a VectorWorks document. BeginFloor uses 2D object creation procedure calls to define the "template" for the object.

After specifying object procedure calls to define the floor object, you should call EndGroup to complete the column definition and create the actual object.

Parameters:

thicknessDistance Floor thickness.

Example:

BeginFloor(6");
Rect(1,1,5,5);
EndGroup;



  BeginRoof Objects - Architectural 

Declaration:

PROCEDURE   BeginRoof
(   p1X :REAL;
    p1Y :REAL;
    p2X :REAL;
    p2Y :REAL;
    upslopeX :REAL;
    upslopeY :REAL;
    riseDistance :REAL;
    runDistance :REAL;
    miter :INTEGER;
    vertPart :REAL
) ;

Description:

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

Table - Roof Miter Styles

Miter Style Constant
Horizontal 1
Vertical 2
Horizontal-Vertical 2


3-D View of Roof

Parameters:

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

Example:

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;




  BreakWall Objects - Architectural 

Declaration:

PROCEDURE   BreakWall
(   offsetDistance :REAL;
    breakWidthDistance :REAL;
    right :BOOLEAN
) ;

Description:

Procedure BreakWall creates a break in a wall object on the left or the right at a specified offset location.

Parameters:

offsetDistance Offset distance from wall start.
breakWidthDistance Width of wall break.
right Left-right edge status of break.

Example:

MoveTo(2,3);
WallTo(7,3);
BreakWall(3",1",True);
{creates a right hand 1" wall break 3" from the start of the wall}



  ClearCavities Objects - Architectural 

Declaration:

PROCEDURE   ClearCavities
;

Description:

Procedure ClearCavities resets the default cavity style of wall objects to no cavities.

Example:

DoubLines(6");
AddCavity(True,1",2",2);
Wall(0,1,9,1);
ClearCavities;
Wall(0,2,11,2);
{creates a wall with a cavity, then creates a wall without a cavity}



  CreateBatDormer Objects - Architectural 

Declaration:

FUNCTION   CreateBatDormer
( object:HANDLE ) :INTEGER ;

Description:

Function CreateBatDormer creates a bat dormer in the referenced roof object.

Parameters:

object Handle to roof.

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0",2'0",10'0");
batID := CreateBatDormer(roofHandle);
SetBatAttributes(roofHandle,batID,TRUE,5'0",10'0",4'0",6'3",2'0",#8°0'0");
SetDormerAttributes(roofHandle,batID,3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  CreateGableDormer Objects - Architectural 

Declaration:

FUNCTION   CreateGableDormer
( object:HANDLE ) :INTEGER ;

Description:

Function CreateGableDormer creates a gable dormer in the referenced roof object.

Parameters:

object Handle to roof.

Example:

roofHandle:=CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0" ,2'0",10'0");
gabID:=CreateGableDormer(roofHandle);
SetGableAttributes(roofHandle,gabID,TRUE,6'0",10'0",2'0",#45°0'0",#45°0'0");
SetDormerAttributes(roofHandle,gabID,3,18'4",TRUE,3'0",63,FALSE,
3'0");
SetDormerThick(roofHandle, 2",1.83333");



  CreateHipDormer Objects - Architectural 

Declaration:

FUNCTION   CreateHipDormer
( object:HANDLE ) :INTEGER ;

Description:

Function CreateHipDormer creates a hip dormer in the referenced roof object.

Parameters:

object Handle to roof.

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle, -77'10",21'4.81922",#45°0'0",2'0",10'0");
hID := CreateHipDormer(roofHandle);
SetHipAttributes(roofHandle, hID,TRUE,6'0",10'0",2'0",#45°0'0",#45°0'0",#45°0'0");
SetDormerAttributes(roofHandle,hID,3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  CreateRoof Objects - Architectural 

Declaration:

FUNCTION   CreateRoof
(   genGableWall :BOOLEAN;
    bearingInsetDistance :REAL;
    roofThickDistance :REAL;
    miterType :INTEGER;
    vertMiterDistance :REAL
) :HANDLE ;

Description:

Function CreateRoof creates a new roof object in a VectorWorks document, returning a handle to the object. To define the roof object template, use AppendRoofEdge.

Parameters:

genGableWall Specifies gable roof generation.
bearingInsetDistance Bearing inset distance of wall into roof.
roofThickDistance Roof thickness.
miterType Miter style of roof.
vertMiterDistance Vertical component for double miters.

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,0");
AppendRoofEdge(roofHandle, -87'4",-38'4",#45° 0' 0" ,2'0",10'0");
AppendRoofEdge(roofHandle, -30'2",-38'4",#45° 0' 0" ,2'0",10'0");
AppendRoofEdge(roofHandle, -30'2",45'10",#45° 0' 0" ,2'0",10'0");
AppendRoofEdge(roofHandle, -87'4",45'10",#45° 0' 0" ,2'0",10'0");

See Also:

AppendRoofEdge  



  CreateShedDormer Objects - Architectural 

Declaration:

FUNCTION   CreateShedDormer
( object:HANDLE ) :INTEGER ;

Description:

Function CreateShedDormer creates a shed dormer in the referenced roof object.

Parameters:

object Handle to roof.

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0" ,2'0",10'0");
shedID:=CreateShedDormer(roofHandle);
SetShedAttributes(roofHandle,shedID,TRUE,6'0",10'0",2'0",#8°0'0");
SetDormerAttributes(roofHandle,shedID,3,18'4",TRUE,3'0",63,FALSE, 3'0");
SetDormerThick(roofHandle, 2",1.83333");



  CreateSkylight Objects - Architectural 

Declaration:

FUNCTION   CreateSkylight
( object:HANDLE ) :INTEGER ;

Description:

Function CreateSkylight creates a new skylight in the referenced roof object.

Parameters:

object Handle to roof.

Example:

skylightID:=CreateSkylight(roofHandle);
SetSkylight(roofHandle,skylightID,6,13'8",2'1",Name2Index('dh2436'));



  CreateTrapeziumDormer Objects - Architectural 

Declaration:

FUNCTION   CreateTrapeziumDormer
( object:HANDLE ) :INTEGER ;

Description:

Function CreateTrapeziumDormer creates a trapezium dormer in the referenced roof object.

Parameters:

object Handle to roof.

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle, -77'10",21'4.81922",#45°0'0",2'0",10'0");
trapID:=CreateTrapeziumDormer(roofHandle);
SetTrapeziumAttributes(roofHandle,trapID,TRUE,6'0",10'0",TRUE,6'0",#0°0'0",#0°0'0",#8°0'0");
SetDormerAttributes(roofHandle,trapID,3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  DeleteWallSym Objects - Architectural 

Declaration:

FUNCTION   DeleteWallSym
( symbolHd:HANDLE ) :BOOLEAN ;

Description:

Function DeleteWallSym deletes the referenced symbol from a wall object.

Parameters:

symbolHd Handle to symbol.

Example:





  GetBatAttributes Objects - Architectural 

Declaration:

PROCEDURE   GetBatAttributes
(   object :HANDLE;
    dormerID :INTEGER;
  VAR  useHeight :BOOLEAN;
  VAR  heightDepth :REAL;
  VAR  bottomWidth :REAL;
  VAR  topWidth :REAL;
  VAR  baseHeight :REAL;
  VAR  controlPoint :REAL;
  VAR  topSlope :REAL
) ;

Description:

Procedure GetBatAttributes returns the attributes of a bat dormer in the referenced roof.

Parameters:

object Handle to roof.
dormerID Index of dormer element.
useHeight Returns if height setting was used to created dormer.
heightDepth Returns height or depth value.
bottomWidth Returns bottom width.
topWidth Returns top width.
baseHeight Returns base height.
controlPoint Returns the control point offset.
topSlope Returns the slope of the bat roof.



  GetDormerAttributes Objects - Architectural 

Declaration:

PROCEDURE   GetDormerAttributes
(   object :HANDLE;
    dormerID :INTEGER;
  VAR  edgeIndex :INTEGER;
  VAR  cornerOffset :REAL;
  VAR  isPerpOffset :BOOLEAN;
  VAR  perpOrHeightOffset :REAL;
  VAR  symName :LONGINT;
  VAR  centerSymbol :BOOLEAN;
  VAR  symOffset :REAL
) ;

Description:

Procedure GetDormerAttributes returns the attributes of a roof element in the referenced roof.

Parameters:

object Handle to roof.
dormerID Index of dormer element.
edgeIndex Index of roof edge.
cornerOffset Returns offset from roof edge corner.
isPerpOffset Returns whether perpendicular offset was used.
perpOrHeightOffset Returns perpendicualr or height offset.
symName Returns index of dormer symbol.
centerSymbol Returns whether symbol was centered.
symOffset Returns symbol offset distance.

See Also:

Index2Name  



  GetDormerThick Objects - Architectural 

Declaration:

PROCEDURE   GetDormerThick
(   object :HANDLE;
  VAR  wallThick :REAL;
  VAR  roofThick :REAL
) ;

Description:

Procedure GetDormerThick returns dormer roof and wall thicknesses for the referenced roof.

Parameters:

object Handle to dormer.
wallThick Returns dormer wall thickness.
roofThick Returns dormer roof thickness.



  GetGableAttributes Objects - Architectural 

Declaration:

PROCEDURE   GetGableAttributes
(   object :HANDLE;
    dormerID :INTEGER;
  VAR  useHeight :BOOLEAN;
  VAR  heightDepth :REAL;
  VAR  bottomWidth :REAL;
  VAR  overhang :REAL;
  VAR  leftSlope :REAL;
  VAR  rightSlope :REAL
) ;

Description:

Procedure GetGableAttributes returns the attributes of a gable dormer in the referenced roof.

Parameters:

object Handle to roof.
dormerID Index of dormer element.
useHeight Returns if height setting was used to created dormer.
heightDepth Returns height or depth value.
bottomWidth Returns bottom width.
overhang Returns overhang width.
leftSlope Returns left roof slope of dormer element.
rightSlope Returns right roof slope of dormer element.



  GetHipAttributes Objects - Architectural 

Declaration:

PROCEDURE   GetHipAttributes
(   object :HANDLE;
    dormerID :INTEGER;
  VAR  useHeight :BOOLEAN;
  VAR  heightDepth :REAL;
  VAR  bottomWidth :REAL;
  VAR  overhang :REAL;
  VAR  leftSlope :REAL;
  VAR  rightSlope :REAL;
  VAR  frontSlope :REAL
) ;

Description:

Procedure GetHipAttributes returns the attributes of a hip dormer in the referenced roof.

Parameters:

object Handle to roof.
dormerID Index of dormer element.
useHeight Returns if height setting was used to created dormer.
heightDepth Returns height or depth value.
bottomWidth Returns bottom width.
overhang Returns overhang distance.
leftSlope Returns slope of left roof.
rightSlope Returns slope of right roof.
frontSlope Returns slope of front roof.



  GetNumRoofElements Objects - Architectural 

Declaration:

FUNCTION   GetNumRoofElements
( object:HANDLE ) :INTEGER ;

Description:

Function GetNumRoofElements returns the number of roof elements (dormers and skylights) in the referenced roof object.

Parameters:

object Handle to roof.



  GetRoofAttributes Objects - Architectural 

Declaration:

FUNCTION   GetRoofAttributes
(   object :HANDLE;
  VAR  genGableWall :BOOLEAN;
  VAR  bearingInset :REAL;
  VAR  roofThick :REAL;
  VAR  miterType :INTEGER;
  VAR  vertMiter :REAL
) :BOOLEAN ;

Description:

Function GetRoofAttributes returns the attributes of the referenced roof object.

Parameters:

object Handle to roof object.
genGableWall Returns gable wal generation state.
bearingInset Returns bearing inset dimension.
roofThick Returns roof thickness.
miterType Returns miter style.
vertMiter Returns vertical miter dimension.



  GetRoofEdge Objects - Architectural 

Declaration:

FUNCTION   GetRoofEdge
(   object :HANDLE;
    index :INTEGER;
  VAR  vertexPtX :REAL;
  VAR  vertexPtY :REAL;
  VAR  slope :REAL;
  VAR  projection :REAL;
  VAR  eaveHeight :REAL
) :BOOLEAN ;

Description:

Procedure GetRoofEdge returns the definition attributes of a roof edge for the referenced roof object.

Parameters:

object Handle to roof.
index Index of roof edge (in a range of 1 - n).
vertexPt Returns coordinates of roof edge definition vertex.
slope Returns slope of roof edge.
projection Retunrs eave overhang dimension.
eaveHeight Returns eave height.



  GetRoofVertices Objects - Architectural 

Declaration:

FUNCTION   GetRoofVertices
( object:HANDLE ) :INTEGER ;

Description:

Function GetRoofVertices returns the number of roof edges in the referenced roof object.

Parameters:

object Handle to roof.



  GetShedAttributes Objects - Architectural 

Declaration:

PROCEDURE   GetShedAttributes
(   object :HANDLE;
    dormerID :INTEGER;
  VAR  useHeight :BOOLEAN;
  VAR  heightDepth :REAL;
  VAR  bottomWidth :REAL;
  VAR  overhang :REAL;
  VAR  topSlope :REAL
) ;

Description:

Procedure GetShedAttributes returns the attributes of a shed dormer in the referenced roof.

Parameters:

object Handle to roof.
dormerID Index of dormer element.
useHeight Returns if height setting was used to created dormer.
heightDepth Returns height or depth value.
bottomWidth Returns bottom width.
overhang Returns overhang distance.
topSlope Returns top slope of dormer roof.



  GetSkylight Objects - Architectural 

Declaration:

PROCEDURE   GetSkylight
(   object :HANDLE;
    skylightID :INTEGER;
  VAR  edgeIndex :INTEGER;
  VAR  cornerOffset :REAL;
  VAR  perpOffset :REAL;
  VAR  symName :LONGINT
) ;

Description:

Function GetSkylight returns the definition attributes of a specified skylight in the referenced roof object.

Parameters:

object Handle to roof.
skylightID Index of skylight element.
edgeIndex Index of roof edge associated with skylight.
cornerOffset Offset of skylight from corner.
perpOffset Offset of skylight from roof edge.
symName Name of skylight symbol.

Example:

GetSkylight(roofHandle,skylightID,edgeID,cOff,pOff,symID);
symbolName:=Index2Name(symID);

See Also:

Index2Name  



  GetTrapeziumAttributes Objects - Architectural 

Declaration:

PROCEDURE   GetTrapeziumAttributes
(   object :HANDLE;
    dormerID :INTEGER;
  VAR  useHeight :BOOLEAN;
  VAR  heightDepth :REAL;
  VAR  bottomWidth :REAL;
  VAR  useTopWidth :BOOLEAN;
  VAR  topWidth :REAL;
  VAR  leftSlope :REAL;
  VAR  rightSlope :REAL;
  VAR  topSlope :REAL
) ;

Description:

Procedure GetTrapeziumAttributes returns the attributes of a trapezium dormer in the referenced roof.

Parameters:

object Handle to roof.
dormerID Index of dormer element.
useHeight Returns if height setting was used to created dormer.
heightDepth Returns height or depth value.
bottomWidth Returns bottom width.
useTopWidth Returns whether top width was used to create dormer.
topWidth Returns top width.
leftSlope Returns left slope of dormer roof.
rightSlope Returns right slope of dormer roof.
topSlope Returns top slope of dormer roof.



  GetWallWidth Objects - Architectural 

Declaration:

FUNCTION   GetWallWidth
:REAL ;

Description:

Function GetWallWidth returns the default wall width setting of the document.




  HWallHeight Objects - Architectural 

Declaration:

PROCEDURE   HWallHeight
(   wallHd :HANDLE;
    startHeightDistance :REAL;
    endHeightDistance :REAL
) ;

Description:

Procedure HWallHeight sets the wall heights of the referenced wall object.

Parameters:

wallHd Handle to wall.
startHeightDistance New start height of wall.
endHeightDistance New end height of wall.

Example:





  HWallWidth Objects - Architectural 

Declaration:

PROCEDURE   HWallWidth
(   wallHd :HANDLE;
    widthDistance :REAL
) ;

Description:

Procedure HWallWidth sets the wall width of the referenced wall object.

Parameters:

wallHd Handle to wall.
widthDistance New wall width.

Example:

HWallWidth(HandleToWall,8");



  InsertSymbol Objects - Architectural 

Declaration:

PROCEDURE   InsertSymbol
(   offsetDistance :REAL;
    heightDistance :REAL;
    flipped :BOOLEAN;
    right :BOOLEAN;
    capped :BOOLEAN;
    symbolName :STRING
) ;

Description:

Procedure InsertSymbol places a specified symbol into a wall.

Parameters:

offsetDistance Offset distance from wall start.
heightDistance Elevation of symbol.
flipped Flip orientation of symbol.
right Left-right orientation of symbol.
capped Cap wall breaks.
symbolName Name of symbol to be inserted in wall.

Example:

MoveTo(3,1);
WallTo(5',5');
InsertSymbol(1',False,False,True,'Door');
{inserts the symbol 'Door' at 1' from the start point of the last wall segment}



  RemoveRoofEdge Objects - Architectural 

Declaration:

FUNCTION   RemoveRoofEdge
(   object :HANDLE;
    index :INTEGER
) :BOOLEAN ;

Description:

Function RemoveRoofEdge removes the specified roof edge from the referenced roof object.

Parameters:

object Handle to roof.
index Index of roof edge to be removed.



  RemoveRoofElement Objects - Architectural 

Declaration:

PROCEDURE   RemoveRoofElement
(   object :HANDLE;
    id :INTEGER
) ;

Description:

Procedure RemoveRoofElement removes the specified roof element from the referenced roof.

Parameters:

object Handle to roof.
id Index of dormer element.



  RoundWall Objects - Architectural 

Declaration:

PROCEDURE   RoundWall
(   centerPtX :REAL;
    centerPtY :REAL;
    startPtX :REAL;
    startPtY :REAL;
    endPtX :REAL;
    endPtY :REAL
) ;

Description:

Procedure RoundWall creates a round wall in a VectorWorks document.

Parameters:

centerPt Center point of wall arc.
startPt Start point of wall arc.
endPt End point of wall arc.



  SetBatAttributes Objects - Architectural 

Declaration:

PROCEDURE   SetBatAttributes
(   object :HANDLE;
    dormerID :INTEGER;
    useHeight :BOOLEAN;
    heightDepthValueDistance :REAL;
    bottomWidthDistance :REAL;
    topWidthDistance :REAL;
    baseHeightDistance :REAL;
    controlPointDistance :REAL;
    topAngle :REAL
) ;

Description:

Procedure SetBatAttributes sets the attributes of a bat dormer in the referenced roof.

Parameters:

object Handle to roof.
dormerID Index of dormer element.
useHeight Use height setting to create dormer element.
heightDepthValueDistance Height/depth distance.
bottomWidthDistance Bottom width.
topWidthDistance Top width.
baseHeightDistance Base height of bat.
controlPointDistance Offset distance of control point.
topAngle Slope of bat roof.

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0",2'0",10'0");
batID := CreateBatDormer(roofHandle);
SetBatAttributes(roofHandle,batID,TRUE,5'0",10'0",4'0",6'3",2'0",#8°0'0");
SetDormerAttributes(roofHandle,batID,3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  SetDormerAttributes Objects - Architectural 

Declaration:

PROCEDURE   SetDormerAttributes
(   object :HANDLE;
    dormerID :INTEGER;
    edgeIndex :INTEGER;
    cornerOffsetDistance :REAL;
    isPerpOffset :BOOLEAN;
    perpOrHeightOffsetDistance :REAL;
    symName :LONGINT;
    centerSymbol :BOOLEAN;
    symOffsetDistance :REAL
) ;

Description:

Procedure SetDormerAttributes sets the attributes of a roof element in the referenced roof.

Parameters:

object Handle to roof.
dormerID Index of dormer element.
edgeIndex Index of roof edge.
cornerOffsetDistance Corner offset distance.
isPerpOffset Specifies perpendicular or height offset.
perpOrHeightOffsetDistance Perpendicular or height offset distance.
symName Index of dormer symbol.
centerSymbol Specifies if symbol is centered.
symOffsetDistance Symbol offset distance.

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0",2'0",10'0");
shedID := CreateShedDormer(roofHandle);
SetShedAttributes(roofHandle,shedID,TRUE,6'0",10'0",2'0",#8°0'0");
SetDormerAttributes(roofHandle, shedID, 3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  SetDormerThick Objects - Architectural 

Declaration:

PROCEDURE   SetDormerThick
(   object :HANDLE;
    wallThickDistance :REAL;
    roofThickDistance :REAL
) ;

Description:

Procedure SetDormerThick sets dormer roof and wall thicknesses for the referenced roof.

Parameters:

object Handle to roof.
wallThickDistance Wall thickness of dormer.
roofThickDistance Roof thickness of dormer.

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0",2'0",10'0");
shedID := CreateShedDormer(roofHandle);
SetShedAttributes(roofHandle,shedID,TRUE,6'0",10'0",2'0",#8°0'0");
SetDormerAttributes(roofHandle, shedID, 3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  SetGableAttributes Objects - Architectural 

Declaration:

PROCEDURE   SetGableAttributes
(   object :HANDLE;
    dormerID :INTEGER;
    useHeight :BOOLEAN;
    heightDepthDistance :REAL;
    bottomWidthDistance :REAL;
    overhangDistance :REAL;
    leftAngle :REAL;
    rightAngle :REAL
) ;

Description:

Procedure SetGableAttributes sets the attributes of a gable dormer in the referenced roof.

Parameters:

object Handle to roof.
dormerID Index of dormer element.
useHeight Use height setting to create dormer element.
heightDepthDistance Height/depth distance.
bottomWidthDistance Bottom width.
overhangDistance Overhang distance.
leftAngle Slope of left roof.
rightAngle Slope of right roof.

Example:

roofHandle:=CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0" ,2'0",10'0");
gabID:=CreateGableDormer(roofHandle);
SetGableAttributes(roofHandle,gabID,TRUE,6'0",10'0",2'0",#45°0'0",#45°0'0");
SetDormerAttributes(roofHandle,gabID,3,18'4",TRUE,3'0",63,FALSE,
3'0");
SetDormerThick(roofHandle, 2",1.83333");



  SetHipAttributes Objects - Architectural 

Declaration:

PROCEDURE   SetHipAttributes
(   object :HANDLE;
    dormerID :INTEGER;
    useHeight :BOOLEAN;
    heightDepthDistance :REAL;
    bottomWidthDistance :REAL;
    overhangDistance :REAL;
    leftAngle :REAL;
    rightAngle :REAL;
    frontAngle :REAL
) ;

Description:

Procedure SetHipAttributes sets the attributes of a hip dormer in the referenced roof.

Parameters:

object Handle to roof.
dormerID Index of dormer element.
useHeight Use height setting to create dormer element.
heightDepthDistance Height/depth distance.
bottomWidthDistance Bottom width.
overhangDistance Overhang distance.
leftAngle Slope of left roof of dormer.
rightAngle Slope of right roof of dormer.
frontAngle Slope of front roof of dormer.

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0",2'0",10'0");
hipID := CreateHipDormer(roofHandle);
SetHipAttributes(roofHandle, hipID,TRUE,6'0",10'0",2'0",#45°0'0",#45°0'0",#45°0'0");
SetDormerAttributes(roofHandle, hipID, 3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  SetRoofAttributes Objects - Architectural 

Declaration:

PROCEDURE   SetRoofAttributes
(   object :HANDLE;
    genGableWall :BOOLEAN;
    bearingInsetDistance :REAL;
    roofThickDistance :REAL;
    miterType :INTEGER;
    vertMiterDistance :REAL
) ;

Description:

Function SetRoofAttributes sets the definition attributes of a roof object in a VectorWorks document.

Parameters:

object Handle to roof .
genGableWall Sets gable roof generation mode.
bearingInsetDistance Sets bearing inset distance.
roofThickDistance Sets roof thickness.
miterType Sets miter style.
vertMiterDistance Specifies vertical miter dimension.



  SetRoofEdge Objects - Architectural 

Declaration:

PROCEDURE   SetRoofEdge
(   object :HANDLE;
    index :INTEGER;
    vertexPtX :REAL;
    vertexPtY :REAL;
    edgeAngle :REAL;
    projectionDistance :REAL;
    eaveHeightDistance :REAL
) ;

Description:

Procedure SetRoofEdge sets the definition attributes of a roof edge for the referenced roof object.

Parameters:

object Handle to roof.
index Index of roof edge.
vertexPt Coordinates of roof edge vertex.
edgeAngle Roof slope.
projectionDistance Eave overhang.
eaveHeightDistance Eave height.



  SetShedAttributes Objects - Architectural 

Declaration:

PROCEDURE   SetShedAttributes
(   object :HANDLE;
    dormerID :INTEGER;
    useHeight :BOOLEAN;
    heightDepthDistance :REAL;
    bottomWidthDistance :REAL;
    overhangDistance :REAL;
    topAngle :REAL
) ;

Description:

Procedure SetShedAttributes sets the attributes of a shed dormer in the referenced roof.

Parameters:

object Handle to roof.
dormerID Index of dormer element.
useHeight Use height setting to create dormer element.
heightDepthDistance Height/depth distance.
bottomWidthDistance Bottom width.
overhangDistance Overhang distance.
topAngle Top angle of dormer element.

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-77'10",21'4.81922",#45°0'0" ,2'0",10'0");
shedID := CreateShedDormer(roofHandle);
SetShedAttributes(roofHandle,shedID,TRUE,6'0",10'0",2'0",#8°0'0");
SetDormerAttributes(roofHandle,shedID,3,18'4",TRUE,3'0",63,FALSE, 3'0");
SetDormerThick(roofHandle, 2",1.83333");



  SetSkylight Objects - Architectural 

Declaration:

PROCEDURE   SetSkylight
(   object :HANDLE;
    skylightID :INTEGER;
    edgeIndex :INTEGER;
    cornerOffsetDistance :REAL;
    perpOffsetDistance :REAL;
    symName :LONGINT
) ;

Description:

Function SetSkylight sets the definition attributes of a skylight in the referenced roof object.

Parameters:

object Handle to roof.
skylightID Index of skylight element.
edgeIndex Index of roof edge associated with skylight.
cornerOffsetDistance Offset of skylight from corner.
perpOffsetDistance Offset of skylight from roof edge.
symName Name of skylight symbol.

Example:

skylightID:=CreateSkylight(roofHandle);
SetSkylight(roofHandle,skylightID,6,13'8",2'1",Name2Index('dh2436'));

See Also:

Name2Index  



  SetTrapeziumAttributes Objects - Architectural 

Declaration:

PROCEDURE   SetTrapeziumAttributes
(   object :HANDLE;
    dormerID :INTEGER;
    useHeight :BOOLEAN;
    heightDpthDistance :REAL;
    bottomWidthDistance :REAL;
    useTopWidth :BOOLEAN;
    topWidthDistance :REAL;
    leftAngle :REAL;
    rightAngle :REAL;
    topAngle :REAL
) ;

Description:

Procedure SetTrapeziumAttributes sets the attributes of a trapezium dormer in the referenced roof.

Parameters:

object Handle to roof.
dormerID Index of dormer element.
useHeight Use height setting to create dormer element.
heightDpthDistance Height/depth distance.
bottomWidthDistance Bottom width.
useTopWidth Use top width to create dormer element.
topWidthDistance Top width.
leftAngle Left roof slope.
rightAngle Right roof slope.
topAngle Top roof slope.

Example:

roofHandle := CreateRoof(TRUE,5 1/2",5 1/2",4,9.52627");
AppendRoofEdge(roofHandle,-77'10",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",-25'3.18078",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle,-41'2",21'4.81922",#45°0'0",2'0",10'0");
AppendRoofEdge(roofHandle, -77'10",21'4.81922",#45°0'0",2'0",10'0");
trapID:=CreateTrapeziumDormer(roofHandle);
SetTrapeziumAttributes(roofHandle,trapID,TRUE,6'0",10'0",TRUE,6'0",#0°0'0",#0°0'0",#8°0'0");
SetDormerAttributes(roofHandle,trapID,3,18'4",TRUE,3'0",63,FALSE,3'0");
SetDormerThick(roofHandle, 2",1.83333");



  SetWallWidth Objects - Architectural 

Declaration:

PROCEDURE   SetWallWidth
( widthDistance:REAL ) ;

Description:

Procedure SetWallWidth sets the default wall width of the document.

Parameters:

widthDistance New default wall width.

Example:





  Wall Objects - Architectural 

Declaration:

PROCEDURE   Wall
(   p1X :REAL;
    p1Y :REAL;
    p2X :REAL;
    p2Y :REAL
) ;

Description:

Procedure Wall creates a wall object in a VectorWorks document. The wall will adopt the current default settings for walls when created.

Parameters:

p1 Start point of wall.
p2 End point of wall.



  WallCap Objects - Architectural 

Declaration:

PROCEDURE   WallCap
(   atStart :BOOLEAN;
    closed :BOOLEAN;
    round :BOOLEAN;
    rightOffDistance :REAL;
    leftOffDistance :REAL
) ;

Description:

Procedure WallCap creates a wall cap on a newly created wall object.

Specifying nonzero values for the cap offset values will create angled wall caps.

Parameters:

atStart Start-end location of wall cap.
closed Controls display status of cap.
round Specifies flat or round cap.
rightOffDistance Right extension of wall line beyond end point.
leftOffDistance Left extension of wall line beyond end point.

Example:

Wall(0,0,7',0);
WallCap(T,T,F,1.0',0.0);
{sets the cap status of the starting cap of the wall as flat cap, bevelled, with the right side extending 1' beyond the wall end point}



  WallHeight Objects - Architectural 

Declaration:

PROCEDURE   WallHeight
(   wallHd :HANDLE;
  VAR  startHt :REAL;
  VAR  endHt :REAL
) ;

Description:

Procedure WallHeight returns the wall heights of the referenced wall object.

Parameters:

wallHd Handle to wall.
startHt Returns start height of wall.
endHt Returns end height of wall.



  WallPeak Objects - Architectural 

Declaration:

PROCEDURE   WallPeak
(   alongDistance :REAL;
    heightDistance :REAL
) ;

Description:

Procedure WallPeak creates a peak(high or low type) at a specified distance from the wall start point.

There is no error checking of the distance or peak height parameters; it is left to the programmer to ensure that the parameter values are valid.

Wall Peak Types

         
Low Peak           High Peak

Parameters:

alongDistance Location of peak (measured from wall start point).
heightDistance Elevation of wall peak.

Example:

SetZVal(0',8');
Wall(0,0,7,0);
WallPeak(3'-6",9'-0");
{creates a 9' wall peak 3'-6" from the start point of the wall}



  WallTo Objects - Architectural 

Declaration:

PROCEDURE   WallTo
(   pX :REAL;
    pY :REAL
) ;

Description:

Procedure WallTo creates a wall object in a VectorWorks document. WallTo begins the wall at the current graphics pen position, with the end point at the specified location.

To explicitly set the start point of the wall, WallTo must be preceded by either Procedure MoveTo, LineTo, Wall, or WallTo. The procedure automatically performs a join/cleanup operation an intersection if the previous procedure was a wall creation procedure.

Parameters:

p End point of wall.

Example:

DoubLines(1/4");
MoveTo(2,3);
WallTo(3,3);
WallTo(3,2);
WallTo(2,2);
WallTo(2,3);
{creates a series of connected wall objects}



  WallWidth Objects - Architectural 

Declaration:

FUNCTION   WallWidth
( wallHd:HANDLE ) :REAL ;

Description:

Function WallWidth returns the wall width of the referenced wall object.

Parameters:

wallHd Handle to wall.