EdgePathMethod Class

class NXOpen.CAE.EdgePathMethod

Bases: NXOpen.SelectionMethod

Represents a NXOpen.CAE.EdgePathMethod.

The edge path method is used by other objects to define a start point (NXOpen.CAE.CAEVertex) and a path defined by connected CAE edges (NXOpen.CAE.CAEEdge). The path is defined by adding seed edges which are each defined by a start point (NXOpen.CAE.CAEVertex) and a an edge (NXOpen.CAE.CAEEdge). The path object uses these seeds as input to an algorithm which will determine the complete, coninuous, path. If the resultant path is not the one desired, this indicates that too few seeds were specified. The path class does not allow a curve to be used more than once in a path. Calling NXOpen.CAE.EdgePathMethod.FlipPath() will flip the direction of the path definition, such that subsequent calls to NXOpen.CAE.EdgePathMethod.GetSeedEdges() or NXOpen.CAE.EdgePathMethod.GetPathEdges() will return seed or path edges in the new, flipped, order along with correspondingly updated start vertices.

To obtain an instance of this class use CAE::SmartSelectionManager

New in version NX9.0.0.

Methods

Method Description
AddSeedEdge Add seed (start vertex and edge) to the end of the path.
Dispose Frees the object from memory.
FlipPath Flip the path start and end.
GetPathEdges Returns the resultant start vertics and edges of the path.
GetSeedEdges Returns the seed start vertices and edges which define the path.
GetSeeds Returns the seed start vertices and edges which define the path.
GetSelectedObjects Returns the objects selected by this NXOpen.SelectionMethod.
RemoveSeedEdge Remove seed (start vertex and edge) from the path.

Method Detail

AddSeedEdge

EdgePathMethod.AddSeedEdge

Overloaded method AddSeedEdge

  • AddSeedEdge(seedStartVertex, seedEdge)
  • AddSeedEdge(seedStartVertex, seedEdge, preferFreeEdges, allowGapJumping, gapJumpingTolerance)

-------------------------------------

Add seed (start vertex and edge) to the end of the path. The vertex defines the start point along the edge. If the addition of the seed would result in an invalid path, the seed will not be added and the function will return an error.

Signature AddSeedEdge(seedStartVertex, seedEdge)

Parameters:

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use overloaded NXOpen.CAE.EdgePathMethod.AddSeedEdge() with additional arguments instead.

License requirements: None.

-------------------------------------

Add seed (start vertex and edge) to the end of the path. The vertex defines the start point along the edge. If the addition of the seed would result in an invalid path, the seed will not be added and the function will return an error.

Signature AddSeedEdge(seedStartVertex, seedEdge, preferFreeEdges, allowGapJumping, gapJumpingTolerance)

Parameters:
  • seedStartVertex (NXOpen.CAE.CAEVertex) – seed vertex
  • seedEdge (NXOpen.CAE.CAEEdge) – seed edge
  • preferFreeEdges (bool) – if true, prefer free edges
  • allowGapJumping (bool) – if true, gaps between edges will be jumped
  • gapJumpingTolerance (float) –

New in version NX10.0.0.

License requirements: None.

-------------------------------------

FlipPath

EdgePathMethod.FlipPath

Flip the path start and end.

This changes the definition of the path such that subsequent calls to NXOpen.CAE.EdgePathMethod.GetSeedEdges() or NXOpen.CAE.EdgePathMethod.GetPathEdges() will return seed or path edges in the new, flipped, order along with correspondingly updated start vertices.

Signature FlipPath()

New in version NX9.0.0.

License requirements: None.

GetPathEdges

EdgePathMethod.GetPathEdges

Returns the resultant start vertics and edges of the path.

These define a path which is continuous from start to end.

Signature GetPathEdges()

Returns:a tuple
Return type:A tuple consisting of (pathStartVertices, pathEdges). pathStartVertices is a list of NXOpen.CAE.CAEVertex. resultant start vertices pathEdges is a list of NXOpen.CAE.CAEEdge. resultant edges

New in version NX9.0.0.

License requirements: None.

GetSeedEdges

EdgePathMethod.GetSeedEdges

Returns the seed start vertices and edges which define the path.

The path object uses these seeds as input to an algorithm which will determine the complete, coninuous, path.

Signature GetSeedEdges()

Returns:a tuple
Return type:A tuple consisting of (seedStartVertices, seedEdges). seedStartVertices is a list of NXOpen.CAE.CAEVertex. seed start vertices seedEdges is a list of NXOpen.CAE.CAEEdge. seed edges

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use NXOpen.CAE.EdgePathMethod.GetSeeds() instead.

License requirements: None.

GetSeeds

EdgePathMethod.GetSeeds

Returns the seed start vertices and edges which define the path.

The path object uses these seeds as input to an algorithm which will determine the complete, coninuous, path. Each seed also specifies the options used by the path algorithm for that segment of the path.

Signature GetSeeds()

Returns:a tuple
Return type:A tuple consisting of (seedStartVertices, seedEdges, preferFreeEdges, allowGapJumping, gapJumpingTolerance). seedStartVertices is a list of NXOpen.CAE.CAEVertex. seed start vertices seedEdges is a list of NXOpen.CAE.CAEEdge. seed edges preferFreeEdges is a list of bool. if true, prefer free edgesallowGapJumping is a list of bool. if true, gaps between edges will be jumpedgapJumpingTolerance is a list of float. if allowGapJumping is true, this is the tolerance to use for jumping gaps between edges

New in version NX10.0.0.

License requirements: None.

RemoveSeedEdge

EdgePathMethod.RemoveSeedEdge

Remove seed (start vertex and edge) from the path.

If the removal of the seed would result in an invalid path, the seed will not be added and the function will return an error.

Signature RemoveSeedEdge(seedEdge)

Parameters:seedEdge (NXOpen.CAE.CAEEdge) – seed edge

New in version NX9.0.0.

License requirements: None.