The RoutingPath object stores a set of path preferences. More...
Public Types | |
| enum | CurveType { Line, Arc, Spline } |
| Describes the types of curves allowed in a routing application. More... | |
| enum | AllowedCornerType { None, Bend, Cope, Miter, Sbend } |
| Describes the types of corners allowed in a routing application. More... | |
| enum | DefaultCornerType { None = -1, Bend, Miter, BendTable } |
| Describes the types of corners allowed in a routing application. More... | |
| enum | RadiusMethod { Radius, Ratio, Table, InnerRadius } |
| Describes method used to determine bend radius on a bend or sbend corner More... | |
| enum | RadiusUnits { None, Inches, Millimeters } |
| Describes units of specified radius value NXOpen.Preferences.RoutingPath.RadiusMethod.Radius only. More... | |
| enum | CreateSmartRcps { False, True } |
| Should Smart RCPs be created during path creation in Create Path? More... | |
| enum | MergeDupRcps { False, True } |
| Should duplicate RCPs be merged after a Transform [Move or Copy] operation? More... | |
| enum | CreateTangency { False, True } |
| Should new splines form tangencies with existing splines when they're created? More... | |
| enum | AddPointsToSpline { False, True } |
| Should points be added to existing spline when they are subdivided to preserve shape? More... | |
| enum | ConfirmBranchSel { False, True } |
| Should a branch selection confirmation dialog be show during Path selection? More... | |
| enum | ContinueUpdOnError { False, True } |
| Should fixed length splines ignore length constraint violations and update? More... | |
| enum | ChainMethod { NoBranch, Continuous, Tangent, Cycle, MinDist, MaxDist } |
| Path curve chaining methods More... | |
| enum | OccChainable { False, True } |
| Chain occurrences of curves ? [i. More... | |
| enum | DisplayObject { False, True } |
| Display a certain routing object? More... | |
| enum | CreateSlopeConstraints { False, True } |
| Create slope associativity constraints during line path creation [from ports only] More... | |
Properties | |
| Tag | Tag [get] |
| Returns the tag of this object. More... | |
Detailed Description
The RoutingPath object stores a set of path preferences.
To obtain an instance of this class, refer to NXOpen.Preferences.RoutingApplicationView
Created in NX4.0.0
Member Enumeration Documentation
Describes units of specified radius value NXOpen.Preferences.RoutingPath.RadiusMethod.Radius only.
| Enumerator | |
|---|---|
| None |
Unspecified. Use units of part file. |
| Inches |
Use inch units |
| Millimeters |
Use metric (mm) units |
Member Function Documentation
| unsafe NXOpen.Preferences.RoutingPath.AllowedCornerType [] NXOpen.Preferences.RoutingPath.GetAllowedCorners | ( | ) |
Query the types of corners allowed in an application view
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.CurveType [] NXOpen.Preferences.RoutingPath.GetAllowedCurves | ( | ) |
Query the types of curves allowed in an application view
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe double NXOpen.Preferences.RoutingPath.GetBendRadius | ( | ) |
Needs a work part and a loaded applicaiton view.
Radius units are converted to work part units automatically. Returns -1 and quits if input requirements are not met.
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.RadiusMethod NXOpen.Preferences.RoutingPath.GetBendRadiusMethod | ( | ) |
Query wether the default corner should use bend ratio.
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.RadiusUnits NXOpen.Preferences.RoutingPath.GetBendRadiusUnits | ( | ) |
Query bend radius units stored in path preferences
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe double NXOpen.Preferences.RoutingPath.GetBendRatio | ( | ) |
Query default bend ratio.
Used when default corner uses bend ratio method
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe string NXOpen.Preferences.RoutingPath.GetBendTable | ( | ) |
Query default bend table.
Used when default corner uses bend table method
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe string [] NXOpen.Preferences.RoutingPath.GetBendTableFilenames | ( | ) |
Query loaded bend table filenames.
A bend table file can contain one or more named bend tables. Loading a bend table file loads all its constituent tables into memory.
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe double NXOpen.Preferences.RoutingPath.GetBendTableRadius | ( | string | bendTableName, |
| double | diameter | ||
| ) |
Query bend radius from a loaded bend table.
Returns a radius of -1 if input table is not loaded
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
bendTableName diameter
- Returns
| unsafe string [] NXOpen.Preferences.RoutingPath.GetBendTables | ( | ) |
Query loaded bend table names.
A bend table maps a stock outer diameter to a radius appropriate for a certain bending machine
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.CurveType [] NXOpen.Preferences.RoutingPath.GetChainableCurveTypes | ( | ) |
Query all the types of chainable curve types
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.ConfirmBranchSel NXOpen.Preferences.RoutingPath.GetConfirmBranchSelection | ( | ) |
Confirm branch selection during Path selection?
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.ContinueUpdOnError NXOpen.Preferences.RoutingPath.GetContinueUpdateOnError | ( | ) |
Query default down direction for fixed length splines
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.AddPointsToSpline NXOpen.Preferences.RoutingPath.GetCreateNewPointsOnSubdivide | ( | ) |
Add points to subdivided splines to maintain shape?
Created in NX6.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.CreateSlopeConstraints NXOpen.Preferences.RoutingPath.GetCreateSlopeConstraints | ( | ) |
Create slope constraints during line path creation to and from fitting ports?
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.CreateSmartRcps NXOpen.Preferences.RoutingPath.GetCreateSmartRcps | ( | ) |
Create smart RCPs during path creation?
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.CreateTangency NXOpen.Preferences.RoutingPath.GetCreateSplineTangency | ( | ) |
Create tangency between splines?
Created in NX6.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.ChainMethod NXOpen.Preferences.RoutingPath.GetCurveChainingMethod | ( | ) |
Query path curve chaining method
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.DefaultCornerType NXOpen.Preferences.RoutingPath.GetDefaultCorner | ( | ) |
Query the default corner type in an application view
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.DisplayObject NXOpen.Preferences.RoutingPath.GetDisplayAnchors | ( | ) |
Display anchors?
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.DisplayObject NXOpen.Preferences.RoutingPath.GetDisplayConnectedPorts | ( | ) |
Display connected ports?
Created in NX8.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe double NXOpen.Preferences.RoutingPath.GetDisplayPortLength | ( | ) |
Displayed port length
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.DisplayObject NXOpen.Preferences.RoutingPath.GetDisplayPorts | ( | ) |
Display ports?
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.DisplayObject NXOpen.Preferences.RoutingPath.GetDisplayRcps | ( | ) |
Display RCPs?
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.DisplayObject NXOpen.Preferences.RoutingPath.GetDisplaySegmentConstraints | ( | ) |
Display segment constraints?
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.CurveType NXOpen.Preferences.RoutingPath.GetHealPathCurveType | ( | ) |
Heal Path curve type.
Created in NX5.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.MergeDupRcps NXOpen.Preferences.RoutingPath.GetMergeDuplicateRcps | ( | ) |
Merge duplicate RCPs after a Transform [Move or Copy] operation?
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe NXOpen.Preferences.RoutingPath.OccChainable NXOpen.Preferences.RoutingPath.GetOccurrenceChainable | ( | ) |
Query if curve occurrences [curves not in the work part] are chainable
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe string NXOpen.Preferences.RoutingPath.GetStockOffsetExpression | ( | ) |
Query default stock offset expression used by Create Path and Create Stock Offset Port [via Qualify Part]
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Returns
| unsafe string NXOpen.Preferences.RoutingPath.LoadBendTableFile | ( | string | bendTableFilename | ) |
Load a specified bend table file.
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
bendTableFilename
- Returns
- Descriptive error text, when appropriate
| unsafe void NXOpen.Preferences.RoutingPath.SetAllowedCorners | ( | NXOpen.Preferences.RoutingPath.AllowedCornerType[] | allowedCorners | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
allowedCorners
| unsafe void NXOpen.Preferences.RoutingPath.SetAllowedCurves | ( | NXOpen.Preferences.RoutingPath.CurveType[] | allowedCurves | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
allowedCurves
| unsafe void NXOpen.Preferences.RoutingPath.SetBendRadius | ( | double | bendRadius | ) |
Needs a work part and a loaded applicaiton view.
Radius units are assumed to be work part units and are set automatically. Returns -1 and quits if input requirements are not met.
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
bendRadius
| unsafe void NXOpen.Preferences.RoutingPath.SetBendRadiusMethod | ( | NXOpen.Preferences.RoutingPath.RadiusMethod | radiusMethod | ) |
Set whether the default corner should use bend ratio.
Created in NX5.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
radiusMethod
| unsafe void NXOpen.Preferences.RoutingPath.SetBendRadiusUnits | ( | NXOpen.Preferences.RoutingPath.RadiusUnits | radiusUnits | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
radiusUnits
| unsafe void NXOpen.Preferences.RoutingPath.SetBendRatio | ( | double | bendRatio | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
bendRatio
| unsafe void NXOpen.Preferences.RoutingPath.SetBendTable | ( | string | bendTableName | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
bendTableName
| unsafe void NXOpen.Preferences.RoutingPath.SetChainableCurveTypes | ( | NXOpen.Preferences.RoutingPath.CurveType[] | chainableCurveTypes | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
chainableCurveTypes
| unsafe void NXOpen.Preferences.RoutingPath.SetConfirmBranchSelection | ( | NXOpen.Preferences.RoutingPath.ConfirmBranchSel | confirmBranchSel | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
confirmBranchSel
| unsafe void NXOpen.Preferences.RoutingPath.SetContinueUpdateOnError | ( | NXOpen.Preferences.RoutingPath.ContinueUpdOnError | update | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
update
| unsafe void NXOpen.Preferences.RoutingPath.SetCreateNewPointsOnSubdivide | ( | NXOpen.Preferences.RoutingPath.AddPointsToSpline | addPoints | ) |
Created in NX6.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
addPoints
| unsafe void NXOpen.Preferences.RoutingPath.SetCreateSlopeConstraints | ( | NXOpen.Preferences.RoutingPath.CreateSlopeConstraints | createSlopeConstraints | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
createSlopeConstraints
| unsafe void NXOpen.Preferences.RoutingPath.SetCreateSmartRcps | ( | NXOpen.Preferences.RoutingPath.CreateSmartRcps | createSmart | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
createSmart
| unsafe void NXOpen.Preferences.RoutingPath.SetCreateSplineTangency | ( | NXOpen.Preferences.RoutingPath.CreateTangency | applyTangency | ) |
Created in NX6.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
applyTangency
| unsafe void NXOpen.Preferences.RoutingPath.SetCurveChainingMethod | ( | NXOpen.Preferences.RoutingPath.ChainMethod | chainMethod | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
chainMethod
| unsafe void NXOpen.Preferences.RoutingPath.SetDefaultCorner | ( | NXOpen.Preferences.RoutingPath.DefaultCornerType | defaultCorner | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
defaultCorner
| unsafe void NXOpen.Preferences.RoutingPath.SetDisplayAnchors | ( | NXOpen.Preferences.RoutingPath.DisplayObject | displayAnchors | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
displayAnchors
| unsafe void NXOpen.Preferences.RoutingPath.SetDisplayConnectedPorts | ( | NXOpen.Preferences.RoutingPath.DisplayObject | displayConnectedPorts | ) |
Display connected ports in the model
Created in NX8.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
displayConnectedPorts
| unsafe void NXOpen.Preferences.RoutingPath.SetDisplayPortLength | ( | double | displayPortLength | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
displayPortLength
| unsafe void NXOpen.Preferences.RoutingPath.SetDisplayPorts | ( | NXOpen.Preferences.RoutingPath.DisplayObject | displayPorts | ) |
Display ports in the model?
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
displayPorts
| unsafe void NXOpen.Preferences.RoutingPath.SetDisplayRcps | ( | NXOpen.Preferences.RoutingPath.DisplayObject | displayRcps | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
displayRcps
| unsafe void NXOpen.Preferences.RoutingPath.SetDisplaySegmentConstraints | ( | NXOpen.Preferences.RoutingPath.DisplayObject | displayConstraints | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
displayConstraints
| unsafe void NXOpen.Preferences.RoutingPath.SetHealPathCurveType | ( | NXOpen.Preferences.RoutingPath.CurveType | healPathCurveType | ) |
Created in NX5.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
healPathCurveType
| unsafe void NXOpen.Preferences.RoutingPath.SetMergeDuplicateRcps | ( | NXOpen.Preferences.RoutingPath.MergeDupRcps | mergeDuplicates | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
mergeDuplicates
| unsafe void NXOpen.Preferences.RoutingPath.SetOccurrenceChainable | ( | NXOpen.Preferences.RoutingPath.OccChainable | occChainable | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
occChainable
| unsafe void NXOpen.Preferences.RoutingPath.SetStockOffsetExpression | ( | string | stockOffsetExp | ) |
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
- Parameters
-
stockOffsetExp
Property Documentation
|
get |
Returns the tag of this object.
The documentation for this class was generated from the following file:
- dotnet_pool/Preferences_RoutingPath.cs