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

Represents a boolean operation . More...

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

Public Types

enum  BooleanType {
  BooleanTypeCreate, BooleanTypeUnite, BooleanTypeSubtract, BooleanTypeIntersect,
  BooleanTypeSew
}
 Boolean operation type. More...
 

Public Member Functions

void GetBooleanOperationAndBody (NXOpen::GeometricUtilities::BooleanOperation::BooleanType *type, NXOpen::Body **targetBody)
 Get the Boolean operation type and target body. More...
 
std::vector< NXOpen::Body * > GetTargetBodies ()
 Get the target bodies. More...
 
void SetBooleanOperationAndBody (NXOpen::GeometricUtilities::BooleanOperation::BooleanType type, NXOpen::Body *targetBody)
 Set the Boolean operation type and target body. More...
 
void SetTargetBodies (const std::vector< NXOpen::Body * > &targetBodies)
 Set the target bodies. More...
 
void SetType (NXOpen::GeometricUtilities::BooleanOperation::BooleanType type)
 Sets the boolean operation type. More...
 
NXOpen::GeometricUtilities::BooleanOperation::BooleanType Type ()
 Returns the boolean operation type. 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

Represents a boolean operation .


Created in NX3.0.1.

Member Enumeration Documentation

Boolean operation type.

Enumerator
BooleanTypeCreate 

Create.

BooleanTypeUnite 

Unite.

BooleanTypeSubtract 

Subtract.

BooleanTypeIntersect 

Intersect.

BooleanTypeSew 

Sew.

Member Function Documentation

void NXOpen::GeometricUtilities::BooleanOperation::GetBooleanOperationAndBody ( NXOpen::GeometricUtilities::BooleanOperation::BooleanType type,
NXOpen::Body **  targetBody 
)

Get the Boolean operation type and target body.


Deprecated:
Deprecated in NX4.0.0. Use GeometricUtilities::BooleanOperation::Type and GeometricUtilities::BooleanOperation::GetTargetBodies instead.


Created in NX3.0.1.

License requirements : None

Parameters
typeboolean type
targetBodytarget body
std::vector<NXOpen::Body *> NXOpen::GeometricUtilities::BooleanOperation::GetTargetBodies ( )

Get the target bodies.

Returns
target bodies of boolean
Created in NX4.0.0.

License requirements : None
void NXOpen::GeometricUtilities::BooleanOperation::SetBooleanOperationAndBody ( NXOpen::GeometricUtilities::BooleanOperation::BooleanType  type,
NXOpen::Body targetBody 
)

Set the Boolean operation type and target body.


Deprecated:
Deprecated in NX4.0.0. Use GeometricUtilities::BooleanOperation::SetType and GeometricUtilities::BooleanOperation::SetTargetBodies instead.


Created in NX3.0.1.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
typeboolean type
targetBodytarget body
void NXOpen::GeometricUtilities::BooleanOperation::SetTargetBodies ( const std::vector< NXOpen::Body * > &  targetBodies)

Set the target bodies.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
targetBodiestarget bodies of boolean
void NXOpen::GeometricUtilities::BooleanOperation::SetType ( NXOpen::GeometricUtilities::BooleanOperation::BooleanType  type)

Sets the boolean operation type.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
typeboolean type
NXOpen::GeometricUtilities::BooleanOperation::BooleanType NXOpen::GeometricUtilities::BooleanOperation::Type ( )

Returns the boolean operation type.


Created in NX4.0.0.

License requirements : None

virtual bool NXOpen::GeometricUtilities::BooleanOperation::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.