NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | List of all members
NXOpen.CAE.EdgePathMethod Class Reference

Represents a NXOpen.CAE.EdgePathMethod . More...

Inheritance diagram for NXOpen.CAE.EdgePathMethod:
NXOpen.SelectionMethod NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Member Functions

unsafe void AddSeedEdge (NXOpen.CAE.CAEVertex seedStartVertex, NXOpen.CAE.CAEEdge seedEdge)
 Add seed (start vertex and edge) to the end of the path. More...
 
unsafe void AddSeedEdge (NXOpen.CAE.CAEVertex seedStartVertex, NXOpen.CAE.CAEEdge seedEdge, bool preferFreeEdges, bool allowGapJumping, double gapJumpingTolerance)
 Add seed (start vertex and edge) to the end of the path. More...
 
unsafe void AddSeedEdge (NXOpen.CAE.CAEVertex seedStartVertex, NXOpen.CAE.CAEEdge seedEdge, bool preferFreeEdges, bool allowGapJumping, double gapJumpingTolerance, NXOpen.CAE.PathType pathMethodType, double dTangentAngleTolerance)
 Add seed (start vertex and edge) to the end of the path. More...
 
unsafe void FlipPath ()
 Flip the path start and end. More...
 
unsafe void GetPathEdges (out NXOpen.CAE.CAEVertex[] pathStartVertices, out NXOpen.CAE.CAEEdge[] pathEdges)
 Returns the resultant start vertics and edges of the path. More...
 
unsafe void GetSeedEdges (out NXOpen.CAE.CAEVertex[] seedStartVertices, out NXOpen.CAE.CAEEdge[] seedEdges)
 Returns the seed start vertices and edges which define the path. More...
 
unsafe void GetSeeds (out NXOpen.CAE.CAEVertex[] seedStartVertices, out NXOpen.CAE.CAEEdge[] seedEdges, out bool[] preferFreeEdges, out bool[] allowGapJumping, out double[] gapJumpingTolerance)
 Returns the seed start vertices and edges which define the path. More...
 
unsafe void RemoveSeedEdge (NXOpen.CAE.CAEEdge seedEdge)
 Remove seed (start vertex and edge) from the path. More...
 
- Public Member Functions inherited from NXOpen.SelectionMethod
unsafe NXOpen.TaggedObject[] GetSelectedObjects ()
 Returns the objects selected by this NXOpen.SelectionMethod . More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.SelectionMethod
override void FreeResource ()
 Frees the object from memory. More...
 
- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 

Detailed Description

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

Created in NX9.0.0

Member Function Documentation

unsafe void NXOpen.CAE.EdgePathMethod.AddSeedEdge ( NXOpen.CAE.CAEVertex  seedStartVertex,
NXOpen.CAE.CAEEdge  seedEdge 
)
inline

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.

Created in NX9.0.0

Deprecated in NX10.0.0. Use overloaded NXOpen.CAE.EdgePathMethod.AddSeedEdge with additional arguments instead.

License requirements: None.

Parameters
seedStartVertexseed vertex
seedEdgeseed edge
unsafe void NXOpen.CAE.EdgePathMethod.AddSeedEdge ( NXOpen.CAE.CAEVertex  seedStartVertex,
NXOpen.CAE.CAEEdge  seedEdge,
bool  preferFreeEdges,
bool  allowGapJumping,
double  gapJumpingTolerance 
)
inline

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.

Created in NX10.0.0

Deprecated in NX1847.0.0. Use overloaded NXOpen.CAE.EdgePathMethod.AddSeedEdge with additional arguments instead.

License requirements: None.

Parameters
seedStartVertexseed vertex
seedEdgeseed edge
preferFreeEdgesif true, prefer free edges
allowGapJumpingif true, gaps between edges will be jumped
gapJumpingTolerance
unsafe void NXOpen.CAE.EdgePathMethod.AddSeedEdge ( NXOpen.CAE.CAEVertex  seedStartVertex,
NXOpen.CAE.CAEEdge  seedEdge,
bool  preferFreeEdges,
bool  allowGapJumping,
double  gapJumpingTolerance,
NXOpen.CAE.PathType  pathMethodType,
double  dTangentAngleTolerance 
)
inline

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.

Created in NX1847.0.0

License requirements: None.

Parameters
seedStartVertexseed vertex
seedEdgeseed edge
preferFreeEdgesif true, prefer free edges
allowGapJumpingif true, gaps between edges will be jumped
gapJumpingToleranceif allowGapJumping is true, this is the tolerance to use for jumping gaps between edges
pathMethodTypepath method type
dTangentAngleTolerancetangent angle tolerance for most tangent path method type
unsafe void NXOpen.CAE.EdgePathMethod.FlipPath ( )
inline

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.

Created in NX9.0.0

License requirements: None.

unsafe void NXOpen.CAE.EdgePathMethod.GetPathEdges ( out NXOpen.CAE.CAEVertex[]  pathStartVertices,
out NXOpen.CAE.CAEEdge[]  pathEdges 
)
inline

Returns the resultant start vertics and edges of the path.

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

Created in NX9.0.0

License requirements: None.

Parameters
pathStartVerticesresultant start vertices
pathEdgesresultant edges
unsafe void NXOpen.CAE.EdgePathMethod.GetSeedEdges ( out NXOpen.CAE.CAEVertex[]  seedStartVertices,
out NXOpen.CAE.CAEEdge[]  seedEdges 
)
inline

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.

Created in NX9.0.0

Deprecated in NX10.0.0. Use NXOpen.CAE.EdgePathMethod.GetSeeds instead.

License requirements: None.

Parameters
seedStartVerticesseed start vertices
seedEdgesseed edges
unsafe void NXOpen.CAE.EdgePathMethod.GetSeeds ( out NXOpen.CAE.CAEVertex[]  seedStartVertices,
out NXOpen.CAE.CAEEdge[]  seedEdges,
out bool[]  preferFreeEdges,
out bool[]  allowGapJumping,
out double[]  gapJumpingTolerance 
)
inline

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.

Created in NX10.0.0

License requirements: None.

Parameters
seedStartVerticesseed start vertices
seedEdgesseed edges
preferFreeEdgesif true, prefer free edges
allowGapJumpingif true, gaps between edges will be jumped
gapJumpingToleranceif allowGapJumping is true, this is the tolerance to use for jumping gaps between edges
unsafe void NXOpen.CAE.EdgePathMethod.RemoveSeedEdge ( NXOpen.CAE.CAEEdge  seedEdge)
inline

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.

Created in NX9.0.0

License requirements: None.

Parameters
seedEdgeseed edge

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