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

Represents a NXOpen::SketchAssociativeTrimBuilder
To create a new instance of this class, use NXOpen::SketchCollection::CreateSketchAssociativeTrimBuilder
Default values. More...

Inheritance diagram for NXOpen::SketchAssociativeTrimBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  TrimOption { TrimOptionKeep, TrimOptionDiscard }
 Represents the keep discard options for selected region. More...
 

Public Member Functions

NXOpen::SectionCreateSection ()
 The function creates a new empty section object and adds it to the builder. More...
 
void DeselectRegion (const NXOpen::Point3d &helpPoint)
 The region corresponding to help point will be delsected from being kept/discarded depending on trim type
Created in NX6.0.0. More...
 
std::vector< NXOpen::Section * > GetSections ()
 This function gets all sections of the trim constraint during create/edit. More...
 
NXOpen::SelectNXObjectListRecipeCurves ()
 Returns the input curves. More...
 
void RemoveSection (NXOpen::Section *section)
 The function removes the given section from the builder
Created in NX6.0.0. More...
 
void ResetRegions ()
 The regions are forced to be deselected
Created in NX6.0.0. More...
 
void SelectRegion (const NXOpen::Point3d &helpPoint)
 The function sets help point for region select. More...
 
void SetTrimType (NXOpen::SketchAssociativeTrimBuilder::TrimOption option)
 Sets the trim region type - if the region needs to be kept/discarded
Created in NX6.0.0. More...
 
NXOpen::SketchAssociativeTrimBuilder::TrimOption TrimType ()
 Returns the trim region type - if the region needs to be kept/discarded
Created in NX6.0.0. More...
 
void UpdateRegions ()
 The regions are recreated and updated to reflect the change in the boundary curves
Created in NX6.0.0. 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 NXOpen::SketchAssociativeTrimBuilder
To create a new instance of this class, use NXOpen::SketchCollection::CreateSketchAssociativeTrimBuilder
Default values.

Property Value

TrimType

Keep


Created in NX5.0.0.

Member Enumeration Documentation

Represents the keep discard options for selected region.

Enumerator
TrimOptionKeep 

Selected region will be kept.

Default set.

TrimOptionDiscard 

Selected region will be discarded.

Member Function Documentation

NXOpen::Section* NXOpen::SketchAssociativeTrimBuilder::CreateSection ( )

The function creates a new empty section object and adds it to the builder.

Returns
New section object
Created in NX6.0.0.

License requirements : None
void NXOpen::SketchAssociativeTrimBuilder::DeselectRegion ( const NXOpen::Point3d helpPoint)

The region corresponding to help point will be delsected from being kept/discarded depending on trim type
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
helpPointHelp point for region selection
std::vector<NXOpen::Section *> NXOpen::SketchAssociativeTrimBuilder::GetSections ( )

This function gets all sections of the trim constraint during create/edit.

Returns
All the sections associated with the builder
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")
NXOpen::SelectNXObjectList* NXOpen::SketchAssociativeTrimBuilder::RecipeCurves ( )

Returns the input curves.

These curves must be a part of a single continuous recipe chain.
Created in NX6.0.0.

License requirements : None

void NXOpen::SketchAssociativeTrimBuilder::RemoveSection ( NXOpen::Section section)

The function removes the given section from the builder
Created in NX6.0.0.



License requirements : None

Parameters
sectionSection object to remove
void NXOpen::SketchAssociativeTrimBuilder::ResetRegions ( )

The regions are forced to be deselected
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::SketchAssociativeTrimBuilder::SelectRegion ( const NXOpen::Point3d helpPoint)

The function sets help point for region select.

The region corresponding to help point will be kept/discarded depending on trim type
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
helpPointHelp point for region selection
void NXOpen::SketchAssociativeTrimBuilder::SetTrimType ( NXOpen::SketchAssociativeTrimBuilder::TrimOption  option)

Sets the trim region type - if the region needs to be kept/discarded
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
optionoption
NXOpen::SketchAssociativeTrimBuilder::TrimOption NXOpen::SketchAssociativeTrimBuilder::TrimType ( )

Returns the trim region type - if the region needs to be kept/discarded
Created in NX6.0.0.



License requirements : None

void NXOpen::SketchAssociativeTrimBuilder::UpdateRegions ( )

The regions are recreated and updated to reflect the change in the boundary curves
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")


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