Share

ShapeBooleanObject: Shape

ShapeBooleanObject : shape {6b963d5f,6e243528}

The ShapeBooleanObject allows you to combline splines into new shapes using boolean operations. Available in 3ds Max 2019 and higher.

Constructor

Class instances not creatable by MAXScript

Properties

Rendering Rollup Properties

<ShapeBooleanObject>.render_renderable(renderable) : boolean

Specifies whether the Shape Boolean is renderable.

<ShapeBooleanObject>.render_displayRenderMesh(displayRenderMesh) : boolean

Specifies whether to display the rendered spline mesh in the viewport. Equivalent to the Enable in Viewport setting in the UI.

<ShapeBooleanObject>.render_useViewportSettings(useViewportSettings) : boolean

Specifies whether to use a separate set of parameters to control how the spline is rendered in the viewport. When this is false, the same settings are used for both the viewport and renderer. When it is true, the render_viewport_* settings below are used instead.

<ShapeBooleanObject>.render_mapcoords(mapcoords) : boolean

Specifies whether to generate mapping coordinates.

<ShapeBooleanObject>.realWorldMapSize : boolean

Specifies whether to use real world map size.

<ShapeBooleanObject>.render_displayRenderSettings(displayRenderSettings) : boolean

Specifies whether to display Renderer settings (true) or Viewport settings in the Shape Boolean UI. This property corresponds to the Viewport / Renderer radio button.

<ShapeBooleanObject>.render_rectangular : boolean     
<ShapeBooleanObject>.render_viewport_rectangular : boolean

Specifies whether to render the spline as an extruded rectangle (true) or as an extruded circle (false).

<ShapeBooleanObject>.thickness : float     
<ShapeBooleanObject>.render_viewport_thickness(viewport_thickness) : float

Specifies the thickness of the rendered radial mesh, for rendering and viewport settings.

<ShapeBooleanObject>.sides : integer     
<ShapeBooleanObject>.render_viewport_sides(viewport_sides) : integer

Specifies the number of sides for the rendered radial mesh, for rendering and viewport settings.

<ShapeBooleanObject>.angle : float     
<ShapeBooleanObject>.render_viewport_angle(viewport_angle) : float

The angle of the radial sides, for the rendering and viewport settings.

<ShapeBooleanObject>.render_viewport_length : float

The extrude segment length (height), when the render_rectangular property is true.

<ShapeBooleanObject>.render_viewport_width : float

The extrude segment width, when the render_rectangular property is true.

<ShapeBooleanObject>.render_viewport_angle2 : float

The angle used when render_rectangular is true.

<ShapeBooleanObject>.render_aspect_locked : boolean     
<ShapeBooleanObject>.render_viewport_aspect_locked : boolean

Specifies whether the aspect ratio between the rendered rectangle length and width is locked or not. The aspect ratio itself is calculated, and is not exposed as a parameter.

<ShapeBooleanObject>.render_auto_smooth : boolean

Specifies wether the rendered mesh is smoothed.

<ShapeBooleanObject>.render_threshold : integer

Specifies the smoothing threshold, if auto smooth is true.

<ShapeBooleanObject>.twist_correction : boolean

Specifies whether twist correction is applied.

<ShapeBooleanObject>.cap : boolean

Specifies whether to cap open ends on the rendered mesh.

<ShapeBooleanObject>.quad_cap : boolean

Specifies whether to use a quad cap on the rendered mesh, if .cap is true.

<ShapeBooleanObject>.cap_segments : integer

Specifies the number of segments to use, if .quad_cap is true.

<ShapeBooleanObject>.sphere_cap : float

Specifies how spherical the cap is, in a range of 0.0 (flat) to 1.0 (spherical).

Inerpolation Rollup Properties

<ShapeBooleanObject>.steps : integer

The number of interpolation steps.

<ShapeBooleanObject>.optimize : boolean

Specifies whether to optimize interpolation.

<ShapeBooleanObject>.adaptive : boolean

Specifies whether to use adaptive interpolation.

Boolean Parameters Rollup Properties

<ShapeBooleanObject>.objects : maxObject array

Contains an array of the operand objects in the shape boolean operation.

<ShapeBooleanObject>.operation : int array

Specifies the boolean operation for each operand, with each item corresponding to an operand in the .objects array.

Possible values are:

  • 0=Union
  • 1=Intersect
  • 2=Subtract
  • 3=Merge
  • 4=Attach
  • 5=Insert
  • 6=Sym. Diff.
<ShapeBooleanObject>.operand_tm : maxObject array

An array of transforms for the corresponding operands in the .objects array.

Operand Parameters Rollup Properties

<ShapeBooleanObject>.option : int array

Specifies the boolean option applied to the corresponding operand in the .objects array. Possible values are:

  • 0=No option
  • 1=Imprint
  • 2=Cookie
<ShapeBooleanObject>.materialOption : integer

Specifies the material options for the operand, where 0=Apply Operand Material, and 1=Retain Original Material.

<ShapeBooleanObject>.displayResult : integer

Specifies whether to display the boolean operation result, where 0=false and 1=true.

<ShapeBooleanObject>.displayOperands : integer

Specifies whether to display the operands, where 0=false and 1=true.

<ShapeBooleanObject>.operandDisplay : integer

Specifies which operands to display, when .displayOperands=1, where 0=All Operands, and 1=Selected Operands.

<ShapeBooleanObject>.operandsAsEvaluated : integer

Specifies whether to display operands as evaluated, where 0=false, and 1=true.

Seam Parameters Rollup Properties

<ShapeBooleanObject>.seamType : int array

Specifies the seam type, where each item in the array corresponds to the seam type setting for the corresponding operand in the .objects array.

Possible values are: 0=Simple, 1=Fillet, 2=Chamfer.

<ShapeBooleanObject>.seamSize : float array

Specifies the seam size, where each item in the array corresponds to the seam size setting for the corresponding operand in the .objects array.

Other Properties

These properties are not exposed in the Shape Boolean UI.

<ShapeBooleanObject>.iconsize : float

Gets or sets the Shape Boolean icon size in the viewport.

ShapeBooleanObject Interfaces

Interface: ShapeBooleanObject

Properties:

Methods:

 <integer>GetNumOperands()

Returns the number of operands in the ShapeBooleanObject.

 <boolean>GetOperandName <index>index <&string>nameout 
           nameout is Out parameter

Gets the name of the specified operand, as displayed in the Shape Boolean UI.

<boolean>SetOperandName <index>index <string>name

Sets the name of the specified operand as displayed in the Shape Boolean UI. Note that this does not change the operand, that is, setting this to the name of another object in the scene does not make that object an operand. This is equivalent to the Rename command in the right-click menu for the operands list in the Shape Boolean UI.

 <boolean>GetOperandType <index>index <&enum>type 
           type enums: {#system|#generated} 
           type is Out parameter

Gets the type of the specified operand.

 <boolean>GetNumChildren <index>index <&integer>count 
          count is Out parameter

Gets the number of children for the specified operand.

 <boolean>GetOperationType <index>index <&enum>type 
           type enums: {#union|#intersection|#subtraction|#merge|#attach|#insert|#symmetricDifference} 
           type is Out parameter

Gets the operation type for the specified operand.

 <boolean>SetOperationType <index>index <enum>type 
           type enums: {#union|#intersection|#subtraction|#merge|#attach|#insert|#symmetricDifference}

Sets the operand type for the specified operand.

 <boolean>GetOperationOption <index>index <&enum>option 
           option enums: {#none|#imprint|#cookie} 
           option is Out parameter

Gets the operand option for the specified operand.

 <boolean>SetOperationOption <index>index <enum>option 
           option enums: {#none|#imprint|#cookie}

Sets the operand option for the specified operand.

 <boolean>GetSeamType <index>index <&enum>type 
           type enums: {#simple|#fillet|#chamfer} 
           type is Out parameter

Gets the seam type for the specified operand.

 <boolean>SetSeamType <index>index <enum>type 
           type enums: {#simple|#fillet|#chamfer}

Sets the seam type for the specified operand.

 <boolean>GetSeamSize <index>index <time>time <&float>size <&interval>valid 
           size is Out parameter 
           valid is In and Out parameter

Gets the seam size for the specified operand.

 <boolean>SetSeamSize <index>index <time>time <float>size

Sets the seam size for the specified operand.

 <boolean>GetSolo <index>operandIndex <&boolean>solo 
           solo is Out parameter

Gets the "solo" setting for the specified operand. This indicates whether it is isolated in the UI.

 <boolean>SetSolo <index>operandIndex <boolean>solo

Sets the "solo" setting for the specified operand.

 <boolean>GetSoloOperandIndex <&index>operandIndex 
          operandIndex is Out parameter

Returns the index of the operand that is set to "Solo" view in the operands list, if one is set, or 0 if none is set, in the operandIndex parameter.

 <boolean>GetDisable <index>operandIndex <&boolean>disable 
          disable is Out parameter

Gets the disabled state of the specified operand.

 <boolean>SetDisable <index>operandIndex <boolean>disable

Sets the disabled state of the specified operand.

 <boolean>HasSubdivs <index>operandIndex <time>time <&boolean>sub 
           sub is Out parameter 
 <boolean>GetSubdivs <index>index <time>time <&integer>subdivs <&interval>valid 
           subdivs is Out parameter 
           valid is In and Out parameter 
 <boolean>SetSubdivs <index>index <time>time <integer>subdivs           
 <boolean>RemoveOperand <index>operandIndex

Removes the specified operand from the operand list.

 <boolean>AppendOperand <node>boolNode <node>operandNode <boolean>hold

Adds the specified scene node to the operand list.

 <boolean>InsertOperand <node>boolNode <node>operandNode <index>where <boolean>hold

Inserts the specified scene node as an operand at the specified index of the operands list.

Actions

Parent page: Shapes - Compound Shapes

Was this information helpful?