Objects - Walls

Declaration:

PROCEDURE AddCavity

( pair :BOOLEAN;

leftOffDistance :REAL;

rightOffDistance :REAL;

pairFill :LONGINT

) ;

Special Notes:

AddCavity is obsolete as of VectorWorks12.0

Description:

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

To apply a bitmap fill pattern, use positive value corresponding to the index of the bitmap pattern. To apply a vector fill pattern, use the negative of the vector fill index (index * -1).

Fill patterns and their associated constants can be found in the VectorScript Appendix.

Parameters:

pair Double line display mode.

leftOffDistance Left edge offset from wall centerline.

rightOffDistance Right edge offset from wall centerline.

pairFill Fill index for filled cavities.

Example:
{ Create wall object with 1" wide cavity using black pattern fill.}
DoubLines(6");
AddCavity(True, 1", 2", 2);
Wall(0, 1, 9, 1);

{ Create wall object with 1" wide cavity using a custom hatch fill.}
DoubLines(6");
AddCavity(True, 1", 2", -Name2Index('My Hatch'));
Wall(0, 1, 9, 1);

AddSymToWall

Objects - Walls

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 - Walls

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.

Alignment	Constant
Centerline	0
Left Edge	1
Right Edge	2

AddWallBottomPeak

Objects - Walls

Declaration:

PROCEDURE AddWallBottomPeak

( wallHd :HANDLE;

offDistance :REAL;

heightDistance :REAL

) ;

Description:

Adds a peak to the bottom of the referenced wall.

Parameters:

wallHd Handle to wall.

offDistance Offset distance of peak from wall start.

heightDistance Height of peak.

Example:
AddWallBottomPeak(h,24'0",2'6");

AddWallPeak

Objects - Walls

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.

BreakWall

Objects - Walls

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 - Walls

Declaration:

PROCEDURE ClearCavities

;

Special Notes:

ClearCavities is obsolete as of VectorWorks12.5

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}

ClearWallPeaks

Objects - Walls

Declaration:

PROCEDURE ClearWallPeaks

( h:HANDLE ) ;

Description:

Removes all wall peaks from the referenced wall.

Parameters:

h Handle to wall.

ConvertToUnstyledWall

Objects - Walls

Declaration:

FUNCTION ConvertToUnstyledWall

( h:HANDLE ) :BOOLEAN ;

Description:

Sets a wall to be unstyled.

CreateWallStyle

Objects - Walls

Declaration:

FUNCTION CreateWallStyle

( wallStyleName:STRING ) :HANDLE ;

Description:

Creates a new Wall Style of the give name. If the name is already in use, the next available name will be used.

Parameters:

wallStyleName The name of the new Wall Style. If the name is already in use, the next available name will be used

Result:

Returns a handle to the new Wall Style.

Example:
PROCEDURE Example;
CONST
   wallStyleName = 'Example Wall Style';
VAR
   wallStyleHandle :HANDLE;
   wdth :REAL;
   fill :LONGINT;
   pwLeft, pwRight, psLeft, psRight :INTEGER;
   boo :BOOLEAN;
BEGIN
   wallStyleHandle := CreateWallStyle(wallStyleName);
   wdth    := 1";
   fill    :=  1; {solid white}
   pwLeft  := 14; {in mils}
   pwRight := 14; {in mils}
   psLeft  :=  2; {solid black}
   psRight :=  2; {solid black}
   boo := InsertNewComponent(wallStyleHandle, 1, wdth, fill, pwLeft, pwRight, psLeft, psRight);
   SetName(wallStyleHandle, wallStyleName); {Reset the wall style name.}
END;
RUN(Example);

DeleteAllComponents

Objects - Walls

Declaration:

FUNCTION DeleteAllComponents

( wall:HANDLE ) :BOOLEAN ;

Description:

Deletes all components in wall. wall can be a wall or Wall Style. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

DeleteComponent

Objects - Walls

Declaration:

FUNCTION DeleteComponent

( wall :HANDLE;

index :INTEGER

) :BOOLEAN ;

Description:

Deletes the nth component, where n is equal to index. wall can be a wall or Wall Style. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component to delete.

See Also:

InsertNewComponent

DeleteWallSym

Objects - Walls

Declaration:

FUNCTION DeleteWallSym

( symbolHd:HANDLE ) :BOOLEAN ;

Description:

Function DeleteWallSym deletes the referenced symbol from a wall object.

Parameters:

symbolHd Handle to symbol.

GetComponentClass

Objects - Walls

Declaration:

FUNCTION GetComponentClass

( wall :HANDLE;

index :INTEGER;

VAR componentClass :LONGINT

) :BOOLEAN ;

Description:

Gets the class of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

componentClass Returns the class of the component.

See Also:

SetComponentClass

GetComponentFill

Objects - Walls

Declaration:

FUNCTION GetComponentFill

( wall :HANDLE;

index :INTEGER;

VAR fill :LONGINT

) :BOOLEAN ;

Description:

Gets the fill of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

fill Returns the fill of the component. Positive values for patterns, negative ref numbers for hatches.

See Also:

SetComponentFill

GetComponentFillColors

Objects - Walls

Declaration:

FUNCTION GetComponentFillColors

( wall :HANDLE;

index :INTEGER;

VAR fillForeColor :INTEGER;

VAR fillBackColor :INTEGER

) :BOOLEAN ;

Description:

Gets the fore and back fill colors of the component at index in wall. If wall is nil, this function operates on the Wall Preferences

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

fillForeColor Returns the fore color of the fill.

fillBackColor Returns the back color of the fill.

See Also:

SetComponentFillColors

GetComponentName

Objects - Walls

Declaration:

FUNCTION GetComponentName

( wall :HANDLE;

index :INTEGER

) :STRING ;

Description:

Gets the name of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

Result:

The name of the component.

See Also:

SetComponentName

GetComponentPenColors

Objects - Walls

Declaration:

FUNCTION GetComponentPenColors

( wall :HANDLE;

index :INTEGER;

VAR leftPenForeColor :INTEGER;

VAR leftPenBackColor :INTEGER;

VAR rightPenForeColor :INTEGER;

VAR rightPenBackColor :INTEGER

) :BOOLEAN ;

Description:

Gets the fore and back colors of the left and right side pens of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

leftPenForeColor Returns the fore color of the left pen.

leftPenBackColor Returns the back color of the left pen.

rightPenForeColor Returns the fore color of the right pen.

rightPenBackColor Returns the back color of the right pen.

See Also:

SetComponentPenColors

GetComponentPenStyles

Objects - Walls

Declaration:

FUNCTION GetComponentPenStyles

( wall :HANDLE;

index :INTEGER;

VAR penStyleLeft :INTEGER;

VAR penStyleRight :INTEGER

) :BOOLEAN ;

Description:

Gets the left and right side pen styles of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

penStyleLeft Returns the pen style of the component's left line. Positive values for patters, negative values for dash styles.

penStyleRight Returns the pen style of the component's right line. Positive values for patterns, negative values for dash styles.

See Also:

SetComponentPenStyles

GetComponentPenWeights

Objects - Walls

Declaration:

FUNCTION GetComponentPenWeights

( wall :HANDLE;

index :INTEGER;

VAR penWeightLeft :INTEGER;

VAR penWeightRight :INTEGER

) :BOOLEAN ;

Description:

Gets the pen weights of the left and right sides of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

penWeightLeft Returns the pen weight of the component's left line.

penWeightRight Returns the pen weight of the component's right line.

See Also:

SetComponentPenWeights

GetComponentUseFillClassAttr

Objects - Walls

Declaration:

FUNCTION GetComponentUseFillClassAttr

( wall :HANDLE;

index :INTEGER;

VAR useClassAttr :BOOLEAN

) :BOOLEAN ;

Description:

Gets the use fill class attributes flag of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

useClassAttr Returns whether or not the component is using class attributes for its fill.

See Also:

SetComponentUseFillClassAttr

GetComponentUsePenClassAttr

Objects - Walls

Declaration:

FUNCTION GetComponentUsePenClassAttr

( wall :HANDLE;

index :INTEGER;

VAR leftPenUseClassAttr :BOOLEAN;

VAR rightPenUseClassAttr :BOOLEAN

) :BOOLEAN ;

Description:

Gets the use class attributes flags of the left and right side pens of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

leftPenUseClassAttr Returns whether or not the component is using class attributes for its left pen.

rightPenUseClassAttr Returns whether or not the component is using class attributes for its right pen.

See Also:

SetComponentUsePenClassAttr

GetComponentWidth

Objects - Walls

Declaration:

FUNCTION GetComponentWidth

( wall :HANDLE;

index :INTEGER;

VAR width :REAL

) :BOOLEAN ;

Description:

Gets the width of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

width Returns the width of the component.

See Also:

SetComponentWidth

GetLayerDeltaZOffset

Objects - Walls

Declaration:

FUNCTION GetLayerDeltaZOffset

( theWall:HANDLE ) :REAL ;

Description:

Returns the wall height's offset to the layer delta z.

Parameters:

theWall The wall.

See Also:

SetLayerDeltaZOffset

GetLinkHeightToLayerDeltaZ

Objects - Walls

Declaration:

FUNCTION GetLinkHeightToLayerDeltaZ

( theWall:HANDLE ) :BOOLEAN ;

Description:

Returns whether or not the wall's height is linked to the layer delta z.

Parameters:

theWall The wall.

See Also:

SetLinkHeightToLayerDeltaZ

GetNumberOfComponents

Objects - Walls

Declaration:

FUNCTION GetNumberOfComponents

( wall :HANDLE;

VAR numComponents :INTEGER

) :BOOLEAN ;

Description:

Gets the number of components in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

numComponents Returns the number of components.

GetNumOfWallBreaks

Objects - Walls

Declaration:

FUNCTION GetNumOfWallBreaks

( wallH :HANDLE;

VAR numWallBreaks :INTEGER

) :BOOLEAN ;

Description:

Gets the number of breaks in a wall.

GetNumWallPeaks

Objects - Walls

Declaration:

FUNCTION GetNumWallPeaks

( h:HANDLE ) :INTEGER ;

Description:

Returns the number of peaks in the referenced wall.

Parameters:

h Handle to wall.

Result:

Returns the number of wall peaks.

GetObjExtentsInWall

Objects - Walls

Declaration:

FUNCTION GetObjExtentsInWall

( symH :HANDLE;

wallH :HANDLE;

VAR startPtX :REAL;

VAR startPtY :REAL;

VAR endPtX :REAL;

VAR endPtY :REAL

) :BOOLEAN ;

Description:

Gets the extents of a Plugin object or symbol that is in a wall. Returns the object's start point and end point along the wall line.

GetWallCaps

Objects - Walls

Declaration:

PROCEDURE GetWallCaps

( theWall :HANDLE;

VAR leftCap :BOOLEAN;

VAR rightCap :BOOLEAN;

VAR round :BOOLEAN

) ;

Description:

Gets the wall's caps.

Parameters:

theWall The wall.

leftCap Returns whether or not the wall has a left cap.

rightCap Returns whether or not the wall has a right cap.

round Returns whether or not the wall's caps are round.

See Also:

SetWallCaps

GetWallCapsOffsets

Objects - Walls

Declaration:

PROCEDURE GetWallCapsOffsets

( theWall :HANDLE;

VAR leftCapLeftOffset :REAL;

VAR leftCapRightOffset :REAL;

VAR rightCapLeftOffset :REAL;

VAR rightCapRightOffset :REAL

) ;

Description:

Get the wall's caps' offsets.

Parameters:

theWall The wall.

leftCapLeftOffset Returns the left offset of the left wall cap.

leftCapRightOffset Returns the right offset of the left wall cap.

rightCapLeftOffset Returns the left offset of the right wall cap.

rightCapRightOffset Returns the right offset of the right wall cap.

See Also:

SetWallCapsOffsets

GetWallControlOffset

Objects - Walls

Declaration:

FUNCTION GetWallControlOffset

:REAL ;

Special Notes:

GetWallControlOffset is obsolete as of VectorWorks12.5

Description:

Returns the default wall control line offset value.

GetWallHalfBreakInfo

Objects - Walls

Declaration:

FUNCTION GetWallHalfBreakInfo

( wallH :HANDLE;

breakIndex :INTEGER;

VAR startPtX :REAL;

VAR startPtY :REAL;

VAR centerPtX :REAL;

VAR centerPtY :REAL;

VAR endPtX :REAL;

VAR endPtY :REAL

) :BOOLEAN ;

Description:

Gets the start point, center point and end point of a half break in a wall along the wall line.

GetWallPeak

Objects - Walls

Declaration:

PROCEDURE GetWallPeak

( h :HANDLE;

index :INTEGER;

VAR xPeak :REAL;

VAR yPeak :REAL;

VAR zPeak :REAL

) ;

Description:

Returns the coordinates of a wall peak in the referenced wall.

Parameters:

h Handle to wall.

index Index of wall peak.

xPeak X-coordinate of wall peak.

yPeak Y-coordinate of wall peak.

zPeak Z-coordinate of wall peak.

GetWallStyle

Objects - Walls

Declaration:

FUNCTION GetWallStyle

( theWall:HANDLE ) :STRING ;

Description:

Gets the name of the Wall Style for theWall.

Parameters:

theWall The wall.

See Also:

SetWallStyle

GetWallThickness

Objects - Walls

Declaration:

FUNCTION GetWallThickness

( h :HANDLE;

VAR thicknessDist :REAL

) :BOOLEAN ;

Description:

Gets the thickness of a wall

GetWallWidth

Objects - Walls

Declaration:

FUNCTION GetWallWidth

:REAL ;

Description:

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

HWallHeight

Objects - Walls

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.

HWallWidth

Objects - Walls

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:

PROCEDURE Example;
VAR
	targetWall, sourceWall :HANDLE;
	cnt1, cnt2, cavs :INTEGER;
BEGIN
	targetWall := FSActLayer;
	MoveTo(0,0);
	WallTo(1,0);
	sourceWall := LNewObj;
	cavs := GetObjectVariableInt(sourceWall, 199);
	HWallWidth(targetWall, WallWidth(sourceWall));
	SetObjectVariableInt(targetWall, 199, cavs);
	FOR cnt2 := 0 TO cavs - 1 DO BEGIN
		SetObjectVariableBoolean(targetWall, 240 + cnt2, GetObjectVariableBoolean(sourceWall, 240 + cnt2)); {cavity is pair}
		SetObjectVariableReal   (targetWall, 200 + cnt2, GetObjectVariableReal   (sourceWall, 200 + cnt2)); {left offset}
		SetObjectVariableReal   (targetWall, 220 + cnt2, GetObjectVariableReal   (sourceWall, 220 + cnt2)); {right offset}
		SetObjectVariableLongInt(targetWall, 260 + cnt2, GetObjectVariableLongInt(sourceWall, 260 + cnt2)); {cavity fill}
		SetObjectVariableInt    (targetWall, 280 + cnt2, GetObjectVariableInt    (sourceWall, 280 + cnt2)); {pen weight}
		SetObjectVariableInt    (targetWall, 300 + cnt2, GetObjectVariableInt    (sourceWall, 300 + cnt2)); {pen style}
	END;
	ResetObject(targetWall);
	DelObject(sourceWall);
END;
RUN(Example);

InsertNewComponent

Objects - Walls

Declaration:

FUNCTION InsertNewComponent

( wall :HANDLE;

index :INTEGER;

widthDistance :REAL;

fill :LONGINT;

pwLeft :INTEGER;

pwRight :INTEGER;

psLeft :INTEGER;

psRight :INTEGER

) :BOOLEAN ;

Description:

Inserts a new component before index in wall. wall can be a wall or Wall Style. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index before which to insert the new component.

widthDistance The width of the component.

fill The fill of the component. Positive values for patterns, negative ref numbers for hatches.

pwLeft The pen weight of the component's left line.

pwRight The pen weight of the component's right line.

psLeft The pen style of the component's left line. Positive values for patterns, negative values for dash styles.

psRight The pen style of the component's right line. Positive values for patterns, negative values for dash styles.

Example:
PROCEDURE Example;
CONST
   wallStyleName = 'Wall 100';
VAR
   wallStyleHandle :HANDLE;
   ClassNum :INTEGER;
   boo :BOOLEAN;
BEGIN
   wallStyleHandle := CreateWallStyle(wallStyleName);
   NameClass('Wall-New');
   ClassNum := Name2Index('Wall-New');
   SetObjectVariableLongInt(WallStyleHandle,1130,ClassNum);
   boo := InsertNewComponent(wallStyleHandle, 1, 100mm,1, 14, 14, 2, 2);
   SetName(wallStyleHandle, wallStyleName); {Reset the wall style name.}

END;
RUN(Example);
See Also:

DeleteComponent

InsertSymbol

Objects - Walls

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}
See Also:

AddSymToWall AddSymToWallEdge

JoinWalls

Objects - Walls

Declaration:

FUNCTION JoinWalls

( firstWall :HANDLE;

secondWall :HANDLE;

firstWallX :REAL;

firstWallY :REAL;

secondWallX :REAL;

secondWallY :REAL;

joinModifier :INTEGER;

capped :BOOLEAN;

showAlerts :BOOLEAN

) :BOOLEAN ;

Description:

This function provides a VectorScript interface to the Wall Join Tool. The parameters firstWall and secondWall are used to specify the pick points that determine which ends of the walls are to be joined, similar to the points requested by the Wall Join Tool.

Parameters:

firstWall The first wall of the join operation. For T joins this is the wall that is extended to meet the second wall.

secondWall The second wall of the join operation.

firstWall The first and second wall points are used to clarify corner joins.

secondWall The first and second wall points are used to clarify corner joins.

joinModifier Specifies the type of join: T-join = 1, L-join = 2, X-join = 3, and auto join = 4.

capped True for capped joins, false for un-capped joins.

showAlerts Show an alert dialog if the join operation fails.

MoveWallByOffset

Objects - Walls

Declaration:

PROCEDURE MoveWallByOffset

( theWall :HANDLE;

VAR offset :REAL

) ;

Description:

Available in Architect only. Moves the wall perpendicular to its definition line by the specified offset and maintains all wall connections. Wall movement may be constrained by the surrounding geometry so the actual amount of the offset is returned.

Parameters:

theWall A handle to the wall to move.

offset The distance to move the given wall. Negative offsets move the wall to the left and positive offsets move the wall to the right. The actual amount the wall was moved is returned in this field.

Result:

The actual amount the wall was moved is passed back in the offset parameter.

ReverseWallSides

Objects - Walls

Declaration:

PROCEDURE ReverseWallSides

( theWall:HANDLE ) ;

Description:

Switch the left and right side of a wall by reversing the direction of the wall. This is an interface to the button with the same name on the Object Info palette.

Parameters:

theWall Handle to the wall to operate on.

Example:
PROCEDURE ReverseWallSidesExample;
VAR
	center_pt, start_pt, end_pt :VECTOR;
	h :HANDLE;
BEGIN
	center_pt.x := 0;
	center_pt.y := 0;
	start_pt.x := 100;
	start_pt.y := 0;
	end_pt.x := 0;
	end_pt.y := 100;
	RoundWall(center_pt.x, center_pt.y, start_pt.x, start_pt.y, end_pt.x, end_pt.y);
	h := LNewObj;
	ReverseWallSides(h);
END;
RUN(ReverseWallSidesExample);

RoundWall

Objects - Walls

Declaration:

PROCEDURE RoundWall

( centerPtX :REAL;

centerPtY :REAL;

startPtX :REAL;

startPtY :REAL;

endPtX :REAL;

endPtY :REAL

) ;

Description:

Procedure RoundWall creates a counter-clockwise round wall.

Parameters:

centerPt Center point of wall arc.

startPt Start point of wall arc.

endPt End point of wall arc.

Example:
PROCEDURE Example;
VAR
	x1, y1, x2, y2, x3, y3 :REAL;
	lineHandle :HANDLE;
BEGIN
	GetPt(x1, y1);
	GetPtL(x1, y1, x2, y2);
	MoveTo(x1, y1);
	LineTo(x2, y2);
	lineHandle := LNewObj;
	GetPtL(x2, y2, x3, y3);
	IF lineHandle <> NIL THEN DelObject(lineHandle);
	RoundWall(x1, y1, x2, y2, x3, y3);
END;
RUN(Example);
See Also:

Wall

SetComponentClass

Objects - Walls

Declaration:

FUNCTION SetComponentClass

( wall :HANDLE;

index :INTEGER;

componentClass :LONGINT

) :BOOLEAN ;

Description:

Sets the class of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

componentClass The class of the component.

See Also:

GetComponentClass

SetComponentFill

Objects - Walls

Declaration:

FUNCTION SetComponentFill

( wall :HANDLE;

index :INTEGER;

fill :LONGINT

) :BOOLEAN ;

Description:

Sets the fill of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

fill The fill of the component. Positive values for patterns, negative object indexes for hatches.

See Also:

GetComponentFill

SetComponentFillColors

Objects - Walls

Declaration:

FUNCTION SetComponentFillColors

( wall :HANDLE;

index :INTEGER;

fillForeColor :INTEGER;

fillBackColor :INTEGER

) :BOOLEAN ;

Description:

Sets the fore and back fill colors of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

fillForeColor The fore color of the fill.

fillBackColor The back color of the fill.

See Also:

GetComponentFillColors

SetComponentName

Objects - Walls

Declaration:

FUNCTION SetComponentName

( wall :HANDLE;

index :INTEGER;

componentName :STRING

) :BOOLEAN ;

Description:

Sets the name of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

componentName The name of the component.

See Also:

GetComponentName

SetComponentPenColors

Objects - Walls

Declaration:

FUNCTION SetComponentPenColors

( wall :HANDLE;

index :INTEGER;

leftPenForeColor :INTEGER;

leftPenBackColor :INTEGER;

rightPenForeColor :INTEGER;

rightPenBackColor :INTEGER

) :BOOLEAN ;

Description:

Sets the fore and back colors of the left and right side pens of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

leftPenForeColor The fore color of the left pen.

leftPenBackColor The back color of the left pen.

rightPenForeColor The fore color of the right pen.

rightPenBackColor The back color of the right pen.

See Also:

GetComponentPenColors

SetComponentPenStyles

Objects - Walls

Declaration:

FUNCTION SetComponentPenStyles

( wall :HANDLE;

index :INTEGER;

penStyleLeft :INTEGER;

penStyleRight :INTEGER

) :BOOLEAN ;

Description:

Sets the left and right pen styles for the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

penStyleLeft The pen style of the component's left line. Positive values for patterns, negative values for dash styles.

penStyleRight The pen style of the component's right line. Positive values for patterns, negative values for dash styles.

See Also:

GetComponentPenStyles

SetComponentPenWeights

Objects - Walls

Declaration:

FUNCTION SetComponentPenWeights

( wall :HANDLE;

index :INTEGER;

penWeightLeft :INTEGER;

penWeightRight :INTEGER

) :BOOLEAN ;

Description:

Sets the left and right pen weights for the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

penWeightLeft The pen weight of the component's left line.

penWeightRight The pen weight of the component's right line.

See Also:

GetComponentPenWeights

SetComponentUseFillClassAttr

Objects - Walls

Declaration:

FUNCTION SetComponentUseFillClassAttr

( wall :HANDLE;

index :INTEGER;

useClassAttr :BOOLEAN

) :BOOLEAN ;

Description:

Sets the use fill class attributes flag of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

useClassAttr Whether or not the component will use class attributes for its fill.

See Also:

GetComponentUseFillClassAttr

SetComponentUsePenClassAttr

Objects - Walls

Declaration:

FUNCTION SetComponentUsePenClassAttr

( wall :HANDLE;

index :INTEGER;

leftPenUseClassAttr :BOOLEAN;

rightPenUseClassAttr :BOOLEAN

) :BOOLEAN ;

Description:

Sets the use class attributes flags of the left and right side pens of the component at index in wall. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

leftPenUseClassAttr Whether or not the component will use class attributes for its left pen.

rightPenUseClassAttr Whether or not the component will use class attributes for its right pen.

See Also:

GetComponentUsePenClassAttr

SetComponentWidth

Objects - Walls

Declaration:

FUNCTION SetComponentWidth

( wall :HANDLE;

index :INTEGER;

widthDistance :REAL

) :BOOLEAN ;

Description:

Sets the width of the nth component where n is equal to index. If wall is nil, this function operates on the Wall Preferences.

Parameters:

wall The wall or Wall Style. Refers to Wall Preferences if nil.

index The index of the component.

widthDistance The width of the component.

See Also:

GetComponentWidth

SetLayerDeltaZOffset

Objects - Walls

Declaration:

FUNCTION SetLayerDeltaZOffset

( theWall :HANDLE;

layerDeltaZOffset :REAL

) :BOOLEAN ;

Description:

Sets the wall height's offset to the layer delta z.

Parameters:

theWall The wall.

layerDeltaZOffset The wall height's offset to the layer delta z.

Result:

Returns success status.

See Also:

GetLayerDeltaZOffset

SetLinkHeightToLayerDeltaZ

Objects - Walls

Declaration:

FUNCTION SetLinkHeightToLayerDeltaZ

( theWall :HANDLE;

linkToLayerDeltaZ :BOOLEAN

) :BOOLEAN ;

Description:

Sets whether or not the wall's height is linked to the layer delta z.

Parameters:

theWall The wall.

linkToLayerDeltaZ Whether or not the wall's height is linked to the layer delta z.

Result:

Returns success status.

See Also:

GetLinkHeightToLayerDeltaZ

SetWallCaps

Objects - Walls

Declaration:

FUNCTION SetWallCaps

( theWall :HANDLE;

leftCap :BOOLEAN;

rightCap :BOOLEAN;

round :BOOLEAN

) :BOOLEAN ;

Description:

Set the wall's caps.

Parameters:

theWall The wall.

leftCap Whether or not the wall has a left cap.

rightCap Whether or not the wall has a right cap.

round Whether or not the wall's caps are round.

Result:

Returns success status.

See Also:

GetWallCaps

SetWallCapsOffsets

Objects - Walls

Declaration:

FUNCTION SetWallCapsOffsets

( theWall :HANDLE;

leftCapLeftDistance :REAL;

leftCapRightDistance :REAL;

rightCapLeftDistance :REAL;

rightCapRightDistance :REAL

) :BOOLEAN ;

Description:

Set the wall's caps' offsets.

Parameters:

theWall The wall.

leftCapLeftDistance The left offset of the left wall cap.

leftCapRightDistance The right offset of the left wall cap.

rightCapLeftDistance The left offset of the right wall cap.

rightCapRightDistance The right offset of the right wall cap.

Result:

Returns success status.

See Also:

GetWallCapsOffsets

SetWallControlOffset

Objects - Walls

Declaration:

PROCEDURE SetWallControlOffset

( offset:REAL ) ;

Special Notes:

SetWallControlOffset is obsolete as of VectorWorks12.5

Description:

Sets the default wall control line offset value.

Parameters:

offset New offset value.

SetWallHeights

Objects - Walls

Declaration:

FUNCTION SetWallHeights

( h :HANDLE;

startHtDistance :REAL;

endHtDistance :REAL

) :BOOLEAN ;

Description:

Sets the wall heights of an unstyled wall. Will return false for a styled wall.

Example:
PROCEDURE Example;
VAR
	h :HANDLE;
	boo :BOOLEAN;
BEGIN
	CallTool(-208);
	h := FSActLayer;
	boo := SetWallHeights(h, 12, 23);
END;
RUN(Example);

SetWallStyle

Objects - Walls

Declaration:

FUNCTION SetWallStyle

( theWall :HANDLE;

wallStyle :STRING;

selectedOffDistance :REAL;

replacingOffDistance :REAL

) :BOOLEAN ;

Description:

Applies the given Wall Style to the given wall, aligning to the given offsets.

Parameters:

theWall The wall.

wallStyle The Wall Style to apply.

selectedOffDistance The offset of the wall to align to.

replacingOffDistance The offset of the Wall Style to align to.

Result:

Returns success status.

See Also:

GetWallStyle

SetWallThickness

Objects - Walls

Declaration:

FUNCTION SetWallThickness

( h :HANDLE;

thicknessDistance :REAL

) :BOOLEAN ;

Description:

Sets the thickness of an unstyled wall without components. Will return false for a styled wall or a wall with components. To change the thickness of a wall with components, add, remove or resize components with InsertNewComponent, DeleteComponent, and SetComponent Width

SetWallWidth

Objects - Walls

Declaration:

PROCEDURE SetWallWidth

( widthDistance:REAL ) ;

Special Notes:

SetWallWidth is obsolete as of VectorWorks12.0

Description:

Procedure SetWallWidth sets the default wall width of the document.

Parameters:

widthDistance New default wall width.

Wall

Objects - Walls

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.

See Also:

RoundWall

WallCap

Objects - Walls

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(True, True, False, 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}

WallFootPrint

Objects - Walls

Declaration:

FUNCTION WallFootPrint

( wallHandle:HANDLE ) :HANDLE ;

Description:

Returns the handle of a polyline representing the footprint of a wall.

Parameters:

wallHandle Handle to the wall

Result:

Returns the handle of a polyline representing the footprint of a wall.

Example:
PROCEDURE GetWallFootPrint;
VAR
	h1, h2 :HANDLE;
BEGIN
	h1 := FSActLayer;
	h2 := WallFootPrint(h1);
END;
RUN(GetWallFootPrint);

WallHeight

Objects - Walls

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 - Walls

Declaration:

PROCEDURE WallPeak

( alongDistance :REAL;

heightDistance :REAL

) ;

Description:

Creates a wall peak of the specified height 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.

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 - Walls

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:
PROCEDURE Example;
VAR
	x1, y1, x2, y2 :REAL;
	resourceID :LONGINT;
	wallStyleCnt :INTEGER;
	wallStyleName :STRING;
	wallStyleHand :HANDLE;
BEGIN
	resourceID := BuildResourceList(127, 113, '', wallStyleCnt);
	IF wallStyleCnt > 0 THEN BEGIN
		wallStyleName := GetNameFromResourceList(resourceID, 1);
		AlrtDialog(wallStyleName);
		wallStyleHand := ImportResourceToCurrentFile(resourceID, 1);
		SetWallPrefStyle(wallStyleName);
	END ELSE BEGIN
		SetWallWidth(3.5");
	END;
	GetPt(x1, y1);
	GetPtL(x1, y1, x2, y2);
	MoveTo(x1, y1);
	WallTo(x2, y2);
END;
RUN(Example);

WallWidth

Objects - Walls

Declaration:

FUNCTION WallWidth

( wallHd:HANDLE ) :REAL ;

Description:

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

Parameters:

wallHd Handle to wall.

See Also:

GetWallThickness HWallWidth

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

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.

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.

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

wall	The wall or Wall Style. Refers to Wall Preferences if nil.
index	The index of the component to delete.

wall	The wall or Wall Style. Refers to Wall Preferences if nil.
numComponents	Returns the number of components.

theWall	The wall.
leftCap	Returns whether or not the wall has a left cap.
rightCap	Returns whether or not the wall has a right cap.
round	Returns whether or not the wall's caps are round.

theWall	The wall.
leftCapLeftOffset	Returns the left offset of the left wall cap.
leftCapRightOffset	Returns the right offset of the left wall cap.
rightCapLeftOffset	Returns the left offset of the right wall cap.
rightCapRightOffset	Returns the right offset of the right wall cap.

h	Handle to wall.
index	Index of wall peak.
xPeak	X-coordinate of wall peak.
yPeak	Y-coordinate of wall peak.
zPeak	Z-coordinate of wall peak.

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

firstWall	The first wall of the join operation. For T joins this is the wall that is extended to meet the second wall.
secondWall	The second wall of the join operation.
firstWall	The first and second wall points are used to clarify corner joins.
secondWall	The first and second wall points are used to clarify corner joins.
joinModifier	Specifies the type of join: T-join = 1, L-join = 2, X-join = 3, and auto join = 4.
capped	True for capped joins, false for un-capped joins.
showAlerts	Show an alert dialog if the join operation fails.

theWall	A handle to the wall to move.
offset	The distance to move the given wall. Negative offsets move the wall to the left and positive offsets move the wall to the right. The actual amount the wall was moved is returned in this field.

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

theWall	The wall.
layerDeltaZOffset	The wall height's offset to the layer delta z.

theWall	The wall.
linkToLayerDeltaZ	Whether or not the wall's height is linked to the layer delta z.

theWall	The wall.
leftCapLeftDistance	The left offset of the left wall cap.
leftCapRightDistance	The right offset of the left wall cap.
rightCapLeftDistance	The left offset of the right wall cap.
rightCapRightDistance	The right offset of the right wall cap.

theWall	The wall.
wallStyle	The Wall Style to apply.
selectedOffDistance	The offset of the wall to align to.
replacingOffDistance	The offset of the Wall Style to align to.

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.

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

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