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

The NXOpen::Assemblies::ConstraintDisplayBuilder can be used to control visibility of constraints and optionally components. More...

Inheritance diagram for NXOpen::Assemblies::ConstraintDisplayBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  VisibleConstraintsRuleOptions { VisibleConstraintsRuleOptionsBetweenComponents, VisibleConstraintsRuleOptionsConnectedToComponents }
 This enum is used to control which constraints are treated as connected to the selected components. More...
 

Public Member Functions

bool ChangeComponentVisibility ()
 Returns the flag indicating whether or not a Show Only operation should be done on the connecting components. More...
 
bool FilterNavigator ()
 Returns the flag indicating whether the assembly navigator should filter hidden constraints. More...
 
NXOpen::SelectDisplayableObjectListObjectSelection ()
 Returns the selected constraints and components. More...
 
void SetChangeComponentVisibility (bool changeComponentVisibility)
 Sets the flag indicating whether or not a Show Only operation should be done on the connecting components. More...
 
void SetFilterNavigator (bool filterNavigator)
 Sets the flag indicating whether the assembly navigator should filter hidden constraints. More...
 
void SetVisibleConstraintsRule (NXOpen::Assemblies::ConstraintDisplayBuilder::VisibleConstraintsRuleOptions visibleConstraintsRule)
 Sets the rule determining which constraints are treated as connected to the selected components. More...
 
NXOpen::Assemblies::ConstraintDisplayBuilder::VisibleConstraintsRuleOptions VisibleConstraintsRule ()
 Returns the rule determining which constraints are treated as connected to the selected components. 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

The NXOpen::Assemblies::ConstraintDisplayBuilder can be used to control visibility of constraints and optionally components.

Any selected constraint is shown, and any constraint that refers to geometry in selected components is shown (subject to the setting of the VisibleConstraintsRule). All other constraints are hidden.
If ChangeComponentVisibility is on, then selected components and components positioned by selected constraints are shown, and all other components are hidden. If ChangeComponentVisibility is off, then component visibility is not affected.

This builder operates on displayed constraints. A displayed constraint represents a single assembly constraint in a given assembly, and need not be in the same part as the assembly constraint it represents. An assembly may contain more than one displayed constraint for a given assembly constraint.

To create a new instance of this class, use NXOpen::Assemblies::AssemblyManager::CreateConstraintDisplayBuilder
Default values.

Property Value

ChangeComponentVisibility

1

FilterNavigator

0

VisibleConstraintsRule

BetweenComponents


Created in NX6.0.0.

Member Enumeration Documentation

This enum is used to control which constraints are treated as connected to the selected components.

Enumerator
VisibleConstraintsRuleOptionsBetweenComponents 

Show only constraints that refer only to selected components.

VisibleConstraintsRuleOptionsConnectedToComponents 

Show only constraints that refer at least once to a selected component.

Member Function Documentation

bool NXOpen::Assemblies::ConstraintDisplayBuilder::ChangeComponentVisibility ( )

Returns the flag indicating whether or not a Show Only operation should be done on the connecting components.


Created in NX6.0.0.

License requirements : None

bool NXOpen::Assemblies::ConstraintDisplayBuilder::FilterNavigator ( )

Returns the flag indicating whether the assembly navigator should filter hidden constraints.


Created in NX6.0.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Assemblies::ConstraintDisplayBuilder::ObjectSelection ( )

Returns the selected constraints and components.

All selected constraints and components are shown when the builder is committed, and so are constraints and components connected to them.
Created in NX6.0.0.

License requirements : None

void NXOpen::Assemblies::ConstraintDisplayBuilder::SetChangeComponentVisibility ( bool  changeComponentVisibility)

Sets the flag indicating whether or not a Show Only operation should be done on the connecting components.


Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
changeComponentVisibilitychangecomponentvisibility
void NXOpen::Assemblies::ConstraintDisplayBuilder::SetFilterNavigator ( bool  filterNavigator)

Sets the flag indicating whether the assembly navigator should filter hidden constraints.


Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
filterNavigatorfilternavigator
void NXOpen::Assemblies::ConstraintDisplayBuilder::SetVisibleConstraintsRule ( NXOpen::Assemblies::ConstraintDisplayBuilder::VisibleConstraintsRuleOptions  visibleConstraintsRule)

Sets the rule determining which constraints are treated as connected to the selected components.


Created in NX6.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
visibleConstraintsRulevisibleconstraintsrule
NXOpen::Assemblies::ConstraintDisplayBuilder::VisibleConstraintsRuleOptions NXOpen::Assemblies::ConstraintDisplayBuilder::VisibleConstraintsRule ( )

Returns the rule determining which constraints are treated as connected to the selected components.


Created in NX6.0.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.