nxopen.features

Interface BooleanBuilder

public interface BooleanBuilder

Represents a boolean feature builder.
To create a new instance of this class, use FeatureCollection.createBooleanBuilderUsingCollector(BooleanFeature)

Created in NX4.0.0

Method Summary

Modifier and Type	Method and Description
BooleanRegionSelect	booleanRegionSelect() Returns the boolean region select object License requirements: solid_modeling ("SOLIDS MODELING") .
boolean	convertToSew() Returns the convert to sew flag License requirements: None.
boolean	copyTargets() Returns the copy targets flag License requirements: None.
boolean	copyTools() Returns the copy tools flag License requirements: None.
Feature.BooleanType	operation() Returns the boolean operation License requirements: None.
boolean	retainTarget() Returns the retain target flag License requirements: None.
boolean	retainTool() Returns the retain tool flag License requirements: None.
void	setConvertToSew(boolean convertToSew) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setCopyTargets(boolean copyTargets) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setCopyTools(boolean copyTools) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setOperation(Feature.BooleanType operation) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setRetainTarget(boolean retainTarget) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setRetainTool(boolean retainTool) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setTarget(Body target) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setTolerance(double tolerance) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setTool(DisplayableObject tool) Deprecated. Deprecated in NX5.0.2. Use Features.BooleanBuilder#setToolBodyCollector instead.
void	setToolBodyCollector(ScCollector toolBodyCollector) License requirements: None.
Body	target() Returns the target body License requirements: None.
SelectBodyList	targets() Returns the target bodies for the boolean operation License requirements: None.
double	tolerance() Returns the tolerance License requirements: None.
DisplayableObject	tool() Deprecated. Deprecated in NX5.0.2. Use Features.BooleanBuilder#toolBodyCollector instead.
ScCollector	toolBodyCollector() Returns the tool body collector for the boolean operation License requirements: None.
SelectDisplayableObjectList	tools() Returns the tool bodies for the boolean operation License requirements: None.

Method Detail

operation

Feature.BooleanType operation()
                       throws NXException,
                              RemoteException

Returns the boolean operation
License requirements: None.

Created in NX4.0.0

Returns:

Type of boolean operation.

Throws:

NXException

RemoteException

target

Body target()
     throws NXException,
            RemoteException

Returns the target body
License requirements: None.

Created in NX4.0.0

Returns:

Target body for boolean operation.

Throws:

NXException

RemoteException

tool

DisplayableObject tool()
                throws NXException,
                       RemoteException

Deprecated. Deprecated in NX5.0.2. Use Features.BooleanBuilder#toolBodyCollector instead.

Returns the tool body
License requirements: None.

Created in NX4.0.0

Returns:

Tool body for boolean operation.

Throws:

NXException

RemoteException

retainTarget

boolean retainTarget()
              throws NXException,
                     RemoteException

Returns the retain target flag
License requirements: None.

Created in NX4.0.0

Returns:

Retain target flag

Throws:

NXException

RemoteException

retainTool

boolean retainTool()
            throws NXException,
                   RemoteException

Returns the retain tool flag
License requirements: None.

Created in NX4.0.0

Returns:

Retain tool flag

Throws:

NXException

RemoteException

setOperation

void setOperation(Feature.BooleanType operation)
           throws NXException,
                  RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX4.0.0

Parameters:

operation - Type of boolean operation.

Throws:

NXException

RemoteException

setTarget

void setTarget(Body target)
        throws NXException,
               RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX4.0.0

Parameters:

target - Target body for boolean operation. This parameter may not be null.

Throws:

NXException

RemoteException

setTool

void setTool(DisplayableObject tool)
      throws NXException,
             RemoteException

Deprecated. Deprecated in NX5.0.2. Use Features.BooleanBuilder#setToolBodyCollector instead.

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX4.0.0

Parameters:

tool - Tool body for boolean operation. This parameter may not be null.

Throws:

NXException

RemoteException

setRetainTarget

void setRetainTarget(boolean retainTarget)
              throws NXException,
                     RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX4.0.0

Parameters:

retainTarget - Retain target flag

Throws:

NXException

RemoteException

setRetainTool

void setRetainTool(boolean retainTool)
            throws NXException,
                   RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX4.0.0

Parameters:

retainTool - Retain tool flag

Throws:

NXException

RemoteException

targets

SelectBodyList targets()
                throws NXException,
                       RemoteException

Returns the target bodies for the boolean operation
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

tools

SelectDisplayableObjectList tools()
                           throws NXException,
                                  RemoteException

Returns the tool bodies for the boolean operation
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

toolBodyCollector

ScCollector toolBodyCollector()
                       throws NXException,
                              RemoteException

Returns the tool body collector for the boolean operation
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setToolBodyCollector

void setToolBodyCollector(ScCollector toolBodyCollector)
                   throws NXException,
                          RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

toolBodyCollector -

Throws:

NXException

RemoteException

copyTargets

boolean copyTargets()
             throws NXException,
                    RemoteException

Returns the copy targets flag
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setCopyTargets

void setCopyTargets(boolean copyTargets)
             throws NXException,
                    RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX5.0.0

Parameters:

copyTargets -

Throws:

NXException

RemoteException

copyTools

boolean copyTools()
           throws NXException,
                  RemoteException

Returns the copy tools flag
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setCopyTools

void setCopyTools(boolean copyTools)
           throws NXException,
                  RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX5.0.0

Parameters:

copyTools -

Throws:

NXException

RemoteException

convertToSew

boolean convertToSew()
              throws NXException,
                     RemoteException

Returns the convert to sew flag
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setConvertToSew

void setConvertToSew(boolean convertToSew)
              throws NXException,
                     RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX5.0.0

Parameters:

convertToSew -

Throws:

NXException

RemoteException

tolerance

double tolerance()
          throws NXException,
                 RemoteException

Returns the tolerance
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setTolerance

void setTolerance(double tolerance)
           throws NXException,
                  RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX5.0.0

Parameters:

tolerance -

Throws:

NXException

RemoteException

booleanRegionSelect

BooleanRegionSelect booleanRegionSelect()
                                 throws NXException,
                                        RemoteException

Returns the boolean region select object
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX8.5.0

Throws:

NXException

RemoteException