Interface: Collapse

The Collapse interface exposes the functionality of the Collapse Utility.

Example:

b1 = box pos:[0,0,0]
s1 = sphere pos:[15,0,0]
s2 = sphere pos:[-15,0,0]
select b1
selectmore s1
selectmore s2
collapse.setDoBool true
collapse.setOutputType #Mesh
collapse.setCollapseTo #Single
collapse.SetBoolType #SUBTRACTION
collapse.doCollapse $

Properties:

None

Methods:

<void>DoCollapse <&node array>nodeSet
    nodeSet is In and Out parameter

Collapses the nodes contained in the nodeSet array into a single Editable mesh, optionally performing a boolean operation on them at the same time.

<enum>GetOutputType()
    GetOutputType enums: {#Mesh|#StackResult}

Returns the output type for the collapse operation, either #Mesh (a single Editable Mesh) or #StackResult (modifier stack collapse result).

<void>SetOutputType <enum>outputType
    outputType enums: {#Mesh|#StackResult}

Sets the output type for the collapse operation, either #Mesh (a single Editable Mesh) or #StackResult (modifier stack collapse result).

<enum>GetCollapseTo()
    GetCollapseTo enums: {#Single|#Multiple}

Gets the number of outputs the collapse operation will create:

#Single - a single Editable Mesh
#Multiple - each node is collapsed into it's own Editable Mesh

<void>SetCollapseTo <enum>CollapseToType
    CollapseToType enums: {#Single|#Multiple}

Sets the number of outputs the collapse operation will create:

#Single - a single Editable Mesh
#Multiple - each node is collapsed into it's own Editable Mesh

<boolean>GetDoBool()

Returns whether the collapse operation will also perform a boolean operation.

<void>SetDoBool <boolean>DoBool

Sets whether the collapse operation will also perform a boolean operation.

<enum>GetBoolType()
    GetBoolType enums: {#UNION|#INTERSECTION|#SUBTRACTION}

Gets the type of optional boolean operation that will be performed:

#UNION - union operation
#INTERSECTION - intersection operation
#SUBTRACTION - subtraction operation - the first node in the node list is the one other nodes are subtracted from.

<void>SetBoolType <enum>BoolType
    BoolType enums: {#UNION|#INTERSECTION|#SUBTRACTION}

Sets the type of optional boolean operation that will be performed:

#UNION - union operation
#INTERSECTION - intersection operation
#SUBTRACTION - subtraction operation - the first node in the node list is the one other nodes are subtracted from.

Actions: