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

Applies Assemblies Constraints to a selected NXOpen::Point or NXOpen::Routing::ControlPoint to mimic the update/move behavior of the input smart NXOpen::Point . More...

Inheritance diagram for NXOpen::Routing::StockOffsetPointBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  PointType { PointTypeNormal, PointTypeStockOffset }
 Point Type. More...
 

Public Member Functions

NXOpen::PointConstraintPoint ()
 Returns the point that defines the location of the selected point. More...
 
void GetPointData (NXOpen::Routing::StockOffsetPointBuilder::PointType *pointType, NXOpen::Point **basePoint, NXOpen::Direction **offsetDir, NXString *offsetExpression)
 Gets the stock offset data from the currently selected point or routing control point. More...
 
NXOpen::TaggedObjectGetStockOffsetPointObject ()
 Gets the object on which a Stock Offset Point was based. More...
 
NXOpen::SelectNXObjectPointSelection ()
 Returns the point selection. More...
 
void SetConstraintPoint (NXOpen::Point *point)
 Sets the point that defines the location of the selected point. 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

Applies Assemblies Constraints to a selected NXOpen::Point or NXOpen::Routing::ControlPoint to mimic the update/move behavior of the input smart NXOpen::Point .

The smart point may be a Routing stock offset point (see NXOpen::PointCollection::CreateStockOffsetPoint ) or any of the points created using the NXOpen::PointCollection class.
To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateStockOffsetPointBuilder

Created in NX6.0.0.

Member Enumeration Documentation

Point Type.

Enumerator
PointTypeNormal 

Normal smart point.

PointTypeStockOffset 

Routing stock offset point.

Member Function Documentation

NXOpen::Point* NXOpen::Routing::StockOffsetPointBuilder::ConstraintPoint ( )

Returns the point that defines the location of the selected point.

On commit, this point is used for determining the set of Assemblies Constraints to apply to the selected point (or Routing control point). The input point itself is not used after the commit method.
Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::StockOffsetPointBuilder::GetPointData ( NXOpen::Routing::StockOffsetPointBuilder::PointType pointType,
NXOpen::Point **  basePoint,
NXOpen::Direction **  offsetDir,
NXString offsetExpression 
)

Gets the stock offset data from the currently selected point or routing control point.


Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
pointTypeType of point currently defined.
basePointBase point for stock offset points, NULL for Routing::StockOffsetPointBuilder::PointTypeNormal points.
offsetDirOffset direction for stock offset points, NULL for Routing::StockOffsetPointBuilder::PointTypeNormal points.
offsetExpressionOffset expression for stock offset points, NULL for Routing::StockOffsetPointBuilder::PointTypeNormal points.
NXOpen::TaggedObject* NXOpen::Routing::StockOffsetPointBuilder::GetStockOffsetPointObject ( )

Gets the object on which a Stock Offset Point was based.

Returns NULL if the point is not a Stock Offset Point or if the Stock Offset Point was not offset from another object.

Returns

Created in NX11.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::SelectNXObject* NXOpen::Routing::StockOffsetPointBuilder::PointSelection ( )

Returns the point selection.

Stores the point or Routing control point selected by the user.
Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::StockOffsetPointBuilder::SetConstraintPoint ( NXOpen::Point point)

Sets the point that defines the location of the selected point.

On commit, this point is used for determining the set of Assemblies Constraints to apply to the selected point (or Routing control point). The input point itself is not used after the commit method.
Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
pointpoint

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