VS:Parametric Custom Opening in Wall

From Vectorworks Developer
Jump to: navigation, search

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

By Vladislav Stanev

What's that

When you have a parametric object in put inside a wall, the wall creates opening by the convex hull polygon in 2D and convex hull cube in 3D, created by the 2D and 3D geometry of the parametric.


From VectorWorks 2009 parametric objects are capable of customizing the opening that the parametric object will cut into the wall when placed inside.


The opening is customizable only in 3D.

The opening is creates by boolean operation with the 3D geometry specified from the parametric object and the wall 3D body.

NOTE! The geometry that determines the selection indication is kepts inside each instance. The custom opening is definable only in 3D.


The plug-in creates geometry that is to be used as opening cutting geometry and puts it into special group with the call VS:GetCustomObjectWallHoleGroup.

You can pass handle to what ever 3D object or handle to group object that contains 3D geometry.

  result := GetCustomObjectInfo(objectName, objectHand, recordHand, wallHand);

  { -------------------------------------------------------
    Custom wall opening
    create extrude for cutting the wall
    NOTE: The plug-in must ensure that the cutting 3D geometry
    goes all the way through the wall.
  BeginXtrd( -1000, 1000 );
    AddPoint( -100,-100 );
    AddPoint(  0,-50 );
    AddPoint( 100,-100 );
    AddPoint( 100,100 );
    AddPoint( 0,50 );
    AddPoint( -100,100 );

  { set the cutting geometry }
  result := SetCustomObjectWallHoleGroup( objectHand, LNewObj );

The way it works is that the plug-in provides 3D geometry that is used to cut through the wall.


This way the plug-in parametric object can control the opening. Do recess and sloped openings. Also if you specify a group containing several 3D bodies you can create separate independent openings in the wall for this parametric.

User Comments

The code above needs "set3Drot(LNewObj,90,0,0,0,0,0);" in order to cut the shape shown in the image, as the polygon used in the extrusion would get created on the drawing's ground plane and not on the wall face.

Also, a pair of 2D loci can be used to define the 2D portion of the cut. If more that those 2 loci exist in the PIO, the "cutting" loci need to be at the bottom of the stacking order.

Personal tools

Advanced Search
See Also