aecFPL_areaCutOut - PDS - 2011 R1 - Reference

FrameWorks Plus Programmer's Reference

PPMProductFamily
3D Design and Visualization
PPMProduct
PDS
PPMCategory
Reference

int aecFPL_areaCutOut(solidID, clearance, num, rptFlg, placeSleeve, sleeveType, FWPlinearFlg, UStationFlg, FWPsolidFlg, incremnt, incremntFctr, overrideCutouts);
long solidID
double clearance
int num[5]
int rptFlg
int placeSleeve
int sleeveType
int FWPlinearFlg
int UStationFlg
int FWPsolidFlg
double incrmnt
double incrmntFctr
long overrideCutouts
int InclFireproof
int InclInsulation

Arguments:

Inputs

  • solidID is the ID of the solid to perform the cutout on.

  • clearance is the clearance between the outside of the cutting object and the inside of the hole.

  • rptFlg when set, reports but does not create the cutout.

  • placesleeve flag that when set, places a sleeve if the cutout is around a circular object.

  • sleeveType defines the member type of the sleeve to place. The valid options are: 0 for beam, 1 for column, 2 for vertical brace, and 3 for horizontal brace.

  • FWPlinearFlg flag that when set, performs cutouts for FWP linear members that intersect the solid.

  • UStationFlg flag that when set, performs cutouts for MicroStation solids that intersect the solid.

  • FWPsolidFlg flag that when set, performs cutouts for other FrameWorks Plus solids that intersect the solid.

  • incremnt is the increment factor for the cutout. Refer to the FrameWorks Plus Reference Guide or help for more information on this increment value.

  • incrmntFctr is the increment factor for the cutout. Refer to the FrameWorks Plus Reference Guide or help for more information on this increment factor.

  • overrideCutouts flag to override cutouts. Use 1 to re-create existing cutout with new settings; 0 to not override existing cutout.

  • InclFireproof flag that when set, performs cutouts for FWP linear members placed with fireproofing that intersects the solid.

  • InclInsulation flag that when set, performs cutouts for piping members placed with insulation thickness that intersects the solid.

Outputs

  • num[0] is the number of linear members intersecting the solid.

  • num[1] is the number of FrameWorks Plus solids intersecting the solid.

  • num[2] is the number of MicroStation surfaces and solids intersecting the solid.

  • num[3] is the number of cutout created in the solid.

  • num[4] is reserved for an internal purpose.

Description:

This function performs a group cutout on the solid member with id, solidID. The solid is scanned for intersecting members. Depending on the flags set, a cutout is applied. The number of cutouts performed is returned in num.

Returns:

This function returns 0 if successful or 1 if there is a problem.

See also:

Example:

{
long solidID;
double clearance=0.0;
int num=0, rptFlg, placeSleeve, placeSleeve, sleeveType, FWPlinearFlg, UStationFlg, FWPsolidFlg;
int sts=0;
rptFlg=0; /* do cutout */
placeSleeve=1; /* place a sleeve if possible */
sleeveType=3; /* use H. Braces default section type for sleeve */
FWPlinearFlg=1;/* use FW+ linear members for cutouts */
UStationFlg = FWPsolidFlg = 0; /* do not use Mstn elements or FW+ solids for cutouts */
incremnt=.2;
incremntFctr=.5;
.
.
.
sts = aecFPL_areaCutOut(solidID, clearance, &num, rptFlg, placeSleeve, sleeveType, FWPlinearFlg, UStationFlg, FWPsolidFlg, incremnt, incremntFctr
);
.
.
.
}