NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::GeometricUtilities::BooleanToolBuilder Class Reference

a class which defines boolean tool builder. More...

Inheritance diagram for NXOpen::GeometricUtilities::BooleanToolBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  BooleanToolType { BooleanToolTypeFaceOrPlane, BooleanToolTypeNewPlane, BooleanToolTypeExtrude, BooleanToolTypeRevolve }
 the boolean tool created options More...
 

Public Member Functions

NXOpen::GeometricUtilities::ExtrudeRevolveToolBuilderExtrudeRevolveTool ()
 Returns the ExtrudeRevolveTool builder. More...
 
NXOpen::GeometricUtilities::FacePlaneToolBuilderFacePlaneTool ()
 Returns the FacePlaneTool Builder. More...
 
bool ReverseDirection ()
 Returns the boolean tool reverse direction option
Created in NX7.5.0. More...
 
void SetReverseDirection (bool reverseDirection)
 Sets the boolean tool reverse direction option
Created in NX7.5.0. More...
 
void SetToolOption (NXOpen::GeometricUtilities::BooleanToolBuilder::BooleanToolType toolOption)
 Sets the boolean tool option
Created in NX6.0.0. More...
 
NXOpen::GeometricUtilities::BooleanToolBuilder::BooleanToolType ToolOption ()
 Returns the boolean tool option
Created in NX6.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

a class which defines boolean tool builder.

It provides four types of tool creation methods viz. a set of existing faces or datum planes, a new plane created on the fly (FacePlaneToolBuilder), extrude or revolve sheet bodies created on the fly by a given section and direction (ExtrudeRevolveToolBuilder).


Created in NX6.0.0.

Member Enumeration Documentation

the boolean tool created options

Enumerator
BooleanToolTypeFaceOrPlane 

Tool consists of sets of faces or datum planes.

BooleanToolTypeNewPlane 

Tool consists of plane created on the fly.

BooleanToolTypeExtrude 

Tool consists of extrude created on the fly.

BooleanToolTypeRevolve 

Tool consists of revolve created on the fly.

Member Function Documentation

NXOpen::GeometricUtilities::ExtrudeRevolveToolBuilder* NXOpen::GeometricUtilities::BooleanToolBuilder::ExtrudeRevolveTool ( )

Returns the ExtrudeRevolveTool builder.

Through this tool, the extrude or revolve created on the fly can be queried
Created in NX6.0.0.

License requirements : None

NXOpen::GeometricUtilities::FacePlaneToolBuilder* NXOpen::GeometricUtilities::BooleanToolBuilder::FacePlaneTool ( )

Returns the FacePlaneTool Builder.

Through this tool, the sets of tool faces/datum planes or new plane created on the fly can be queried
Created in NX6.0.0.

License requirements : None

bool NXOpen::GeometricUtilities::BooleanToolBuilder::ReverseDirection ( )

Returns the boolean tool reverse direction option
Created in NX7.5.0.



License requirements : None

void NXOpen::GeometricUtilities::BooleanToolBuilder::SetReverseDirection ( bool  reverseDirection)

Sets the boolean tool reverse direction option
Created in NX7.5.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
reverseDirectionreversedirection
void NXOpen::GeometricUtilities::BooleanToolBuilder::SetToolOption ( NXOpen::GeometricUtilities::BooleanToolBuilder::BooleanToolType  toolOption)

Sets the boolean tool option
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
toolOptiontooloption
NXOpen::GeometricUtilities::BooleanToolBuilder::BooleanToolType NXOpen::GeometricUtilities::BooleanToolBuilder::ToolOption ( )

Returns the boolean tool option
Created in NX6.0.0.



License requirements : None

virtual bool NXOpen::GeometricUtilities::BooleanToolBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.