AddCavity.md

AddCavity

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 [[VS:Function Reference Appendix#Fill Patterns|VectorScript Appendix]].

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

def vs.AddCavity(pair, leftOffDistance, rightOffDistance, pairFill):
    return None

Parameters

Name	Type	Description
pair	BOOLEAN	Double line display mode.
leftOffDistance	REAL	Left edge offset from wall centerline.
rightOffDistance	REAL	Right edge offset from wall centerline.
pairFill	LONGINT	Fill index for filled cavities.

Remarks

(NZH 5-9-05) OBSOLETE for Version 12: Use [[VS:InsertNewComponent]] instead.

Examples

eateWallObjCavity}}

See Also

VS Functions: [InsertNewComponent | InsertNewComponent](InsertNewComponent%20| InsertNewComponent.md)

Version

AddCavity is obsolete as of VectorWorks 12.0.

Availability: from MiniCAD 4.0

Category

• Objects - Walls