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

Represents a builder to be used to split a solid with geometry tools. More...

Inheritance diagram for NXOpen::Tooling::SplitSolidBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  OperationType { OperationTypeSplit, OperationTypeTrim }
 the split operation type: split, trim. More...
 
enum  ToolObjectOption { ToolObjectOptionExistingObject, ToolObjectOptionNewPlane }
 the split tool selection type: Existing Object, New Plane. More...
 

Public Member Functions

bool IsEnlarge ()
 Returns the option to enlarge a split tool or not, the tool should be a face. More...
 
bool ReverseTrimDirection ()
 Returns the option to reverse the trim direction or not. More...
 
void SetEnlarge (bool isEnlarge)
 Sets the option to enlarge a split tool or not, the tool should be a face. More...
 
void SetEnlargedSurfaceData (const std::vector< double > &enlargedSurfaceData)
 Keep enlarged surface data to create enlarged surface. More...
 
void SetReverseTrimDirection (bool reverseTrimDirection)
 Sets the option to reverse the trim direction or not. More...
 
void SetSplitPlane (NXOpen::Plane *splitPlane)
 Sets the plane to be a split tool. More...
 
void SetToolOption (NXOpen::Tooling::SplitSolidBuilder::ToolObjectOption toolOption)
 Sets the tool object selection option
Created in NX7.5.0. More...
 
void SetType (NXOpen::Tooling::SplitSolidBuilder::OperationType splitOrTrim)
 Sets the operation type to do split body or trim body. More...
 
NXOpen::SelectNXObjectSplitObject ()
 Returns the tool object to split the target body. More...
 
NXOpen::PlaneSplitPlane ()
 Returns the plane to be a split tool. More...
 
NXOpen::SelectBodySplitTarget ()
 Returns the target body to be split. More...
 
NXOpen::GeometricUtilities::SurfaceRangeBuilderSurfaceRange ()
 Returns the utility to get enlarged parameters. More...
 
NXOpen::Tooling::SplitSolidBuilder::ToolObjectOption ToolOption ()
 Returns the tool object selection option
Created in NX7.5.0. More...
 
NXOpen::Tooling::SplitSolidBuilder::OperationType Type ()
 Returns the operation type to do split body or trim body. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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 builder to be used to split a solid with geometry tools.


To create a new instance of this class, use NXOpen::Tooling::SplitSolidCollection::CreateSplitSolidBuilder
Default values.

Property Value

IsEnlarge

0

SurfaceRange.AnchorPosition

Vertex1

ToolOption

ExistingObject


Created in NX7.5.0.

Member Enumeration Documentation

the split operation type: split, trim.

Enumerator
OperationTypeSplit 

split option

OperationTypeTrim 

trim option

the split tool selection type: Existing Object, New Plane.

Enumerator
ToolObjectOptionExistingObject 

Existing Object option.

ToolObjectOptionNewPlane 

New Plane option.

Member Function Documentation

bool NXOpen::Tooling::SplitSolidBuilder::IsEnlarge ( )

Returns the option to enlarge a split tool or not, the tool should be a face.


Created in NX7.5.0.

License requirements : None

bool NXOpen::Tooling::SplitSolidBuilder::ReverseTrimDirection ( )

Returns the option to reverse the trim direction or not.


Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::SplitSolidBuilder::SetEnlarge ( bool  isEnlarge)

Sets the option to enlarge a split tool or not, the tool should be a face.


Created in NX7.5.0.

License requirements : None

Parameters
isEnlargeisenlarge
void NXOpen::Tooling::SplitSolidBuilder::SetEnlargedSurfaceData ( const std::vector< double > &  enlargedSurfaceData)

Keep enlarged surface data to create enlarged surface.

Four values passed in represent enlarged parameters in U+, U-, V+ and V-.
Created in NX7.5.0.

License requirements : None

Parameters
enlargedSurfaceDataarray of u and v range values
void NXOpen::Tooling::SplitSolidBuilder::SetReverseTrimDirection ( bool  reverseTrimDirection)

Sets the option to reverse the trim direction or not.


Created in NX7.5.0.

License requirements : None

Parameters
reverseTrimDirectionreversetrimdirection
void NXOpen::Tooling::SplitSolidBuilder::SetSplitPlane ( NXOpen::Plane splitPlane)

Sets the plane to be a split tool.


Created in NX7.5.0.

License requirements : None

Parameters
splitPlanesplitplane
void NXOpen::Tooling::SplitSolidBuilder::SetToolOption ( NXOpen::Tooling::SplitSolidBuilder::ToolObjectOption  toolOption)

Sets the tool object selection option
Created in NX7.5.0.



License requirements : None

Parameters
toolOptiontooloption
void NXOpen::Tooling::SplitSolidBuilder::SetType ( NXOpen::Tooling::SplitSolidBuilder::OperationType  splitOrTrim)

Sets the operation type to do split body or trim body.


Created in NX7.5.0.

License requirements : None

Parameters
splitOrTrimsplitortrim
NXOpen::SelectNXObject* NXOpen::Tooling::SplitSolidBuilder::SplitObject ( )

Returns the tool object to split the target body.


Created in NX7.5.0.

License requirements : None

NXOpen::Plane* NXOpen::Tooling::SplitSolidBuilder::SplitPlane ( )

Returns the plane to be a split tool.


Created in NX7.5.0.

License requirements : None

NXOpen::SelectBody* NXOpen::Tooling::SplitSolidBuilder::SplitTarget ( )

Returns the target body to be split.


Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::SurfaceRangeBuilder* NXOpen::Tooling::SplitSolidBuilder::SurfaceRange ( )

Returns the utility to get enlarged parameters.


Created in NX7.5.0.

License requirements : None

NXOpen::Tooling::SplitSolidBuilder::ToolObjectOption NXOpen::Tooling::SplitSolidBuilder::ToolOption ( )

Returns the tool object selection option
Created in NX7.5.0.



License requirements : None

NXOpen::Tooling::SplitSolidBuilder::OperationType NXOpen::Tooling::SplitSolidBuilder::Type ( )

Returns the operation type to do split body or trim body.


Created in NX7.5.0.

License requirements : None


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