1. Epic GamesDeveloper
  3. FTopologicalEdge

FTopologicalEdge

API > API/Runtime > API/Runtime/CADKernel > API/Runtime/CADKernel/Topo

Inheritance Hierarchy

References

   
Module CADKernel
Header /Engine/Source/Runtime/Datasmith/CADKernel/Base/Public/Topo/TopologicalEdge.h
Include #include "Topo/TopologicalEdge.h"

Syntax

class FTopologicalEdge : public UE::CADKernel::TLinkable< FTopologicalEdge, FEdgeLink >

Variables

  Type Name Description
Protected variable FLinearBoundary Boundary The edge is oriented in the curve orientation i.e. StartCoordinate < EndCoordinate
Protected variable TArray< double > CrossingPointDeltaUMaxs Max delta U at the crossing points to respect meshing criteria
Protected variable TArray< double > CrossingPointDeltaUMins Min delta U at the crossing points to respect meshing criteria
Protected variable TArray< double > CrossingPointUs Temporary discretization of the edge used to compute the mesh of the edge
Protected variable TSharedPtr< FRestrictionCurve > Curve  
Protected variable TArray< FCuttingPoint > CuttingPointUs Final U coordinates of the edge's mesh nodes
Protected variable TSharedPtr< FTopologicalVertex > EndVertex  
Protected variable TArray< FImposedCuttingPoint > ImposedCuttingPointUs U coordinates of the edge's mesh nodes for thin zone purpose
Protected variable double Length3D  
Protected variable FTopologicalLoop * Loop  
Protected variable double Max2DTolerance To avoid huge tolerance in case of degenerated edge, the max tol is defined as Length3D / 10.
Protected variable TSharedPtr< FEdgeMesh > Mesh  
Protected variable TSharedPtr< FTopologicalVertex > StartVertex  
Protected variable TArray< FLinearBoundary > ThinZoneBounds  
Protected variable TArray< FThinZoneSide * > ThinZoneSides  

Constructors

No constructors are accessible with public or protected access.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddImposedCuttingPointU ( const double ImposedCuttingPointU,
const int32 OppositeNodeIndex,
const double DeltaU
)

  
Public function void

AddThinZone ( FThinZoneSide* InThinZoneSide,
const FLinearBoundary& InThinZoneBounds
)

  
Public function void

AddTwinsCuttingPoint ( const double Coord,
const double DeltaU
)

  
Public function Const FPoint

Approximate2DPoint ( const double InCoordinate
)

 Approximation of 2D point defined by its coordinate compute with carrier surface 2D polyline
Public function Const void

Approximate2DPoints ( const TArray< double >& InCoordinates,
TArray< FPoint2D >& OutPoints
)

 Approximation of 2D points defined by its coordinates compute with carrier surface 2D polyline
Public function Const void

ApproximatePoints ( const TArray< double >& InCoordinates,
TArray< FPoint >& OutPoints
)

 Approximation of 3D points compute with carrier surface 3D polyline
Public function Const void Approximation of surfacic polyline (points 2d, 3d, normals, tangents) defined by its coordinates compute with carrier surface polyline
Public function Const bool Checks if the carrier curve is degenerated i.e. the 2d length of the curve is nearly zero If the 3d length is nearly zero, the edge is flag as degenerated
Public function void Generate a sampling of the curve.
Public function void

ComputeEdge2DProperties ( FEdge2DProperties& SlopeCharacteristics
)

 Compute the edge 2D properties i.e. the mean and standard deviation of the slop of the edge in the parametric space of the carrier surface
Public function Const void

ComputeIntersectionsWithIsos ( const TArray< double >& InIsoCoordinates,
const EIso InTypeIso,
const FSurfacicTolerance& ToleranceIso,
TArray< double >& OutIntersection
)

  
Public function void  
Public function Static TSharedPtr< FTopologicalEdge >

CreateEdgeByMergingEdges ( const double SmallEdgeTolerance,
TArray< FOrientedEdge >& Edges,
const TSharedRef< FTopologicalVertex >& StartVertex,
const TSharedRef< FTopologicalVertex >& EndVertex
)

 Merge successive edges of a face in a single edge.
Public function void

Disjoin ()

 Remove the edge and the extremity vertices of the linked entity vs UnlinkTwinEntities delete only the edge link
Public function int32  
Public function Const void

EvaluatePoint ( double InCoordinate,
int32 Derivative,
FCurvePoint& Point
)

 Exact evaluation of point on the 3D curve According to derivativeOrder Gradient of the point (DerivativeOrder = 1) and Laplacian (DerivativeOrder = 1) can also be return
Public function Const void

EvaluatePoints ( const TArray< double >& InCoordinates,
int32 DerivativeOrder,
TArray< FCurvePoint >& OutPoints
)

 Exact evaluation of points on the 3D curve According to derivativeOrder Gradient of the point (DerivativeOrder = 1) and Laplacian (DerivativeOrder = 1) can also be return
Public function bool

ExtendTo ( bool bStartExtremity,
const FPoint2D& NewExtremityCoordinate,
TSharedRef< FTopologicalVertex >& NewVertex
)

 Extend the Edge to the NewVertex.
Public function void  
Public function Const const FLinearBoundary &  
Public function TArray< double > &  
Public function Const const TArray< double > &  
Public function TSharedRef< FRestrictionCurve >  
Public function Const TSharedRef< FRestrictionCurve >  
Public function Const TArray< double >  
Public function Const const TArray< FCuttingPoint > &  
Public function TArray< FCuttingPoint > &  
Public function Const double

GetDeltaUFor ( double Coordinate,
int32& Index
)

  
Public function Const const TArray< double > &  
Public function TArray< double > &  
Public function TArray< double > &  
Public function Const void

GetDiscretization2DPoints ( EOrientation Orientation,
TArray< PointType >& OutPoints
)

 Get the discretization points of the edge and add them to the outpoints TArray
Public function FPoint  
Public function FPoint  
Public function Const double  
Public function TSharedRef< FTopologicalVertex >  
Public function Const const TSharedRef< FTopologicalVertex >  
Public function Const const TSharedRef< FTopologicalVertex >  
Public function Const const TSharedRef< FTopologicalVertex >

GetEndVertex ( bool Forward
)

  
Public function Const void  
Public function Const FTopologicalFace *

GetFace ()

  
Public function Const FTopologicalEdge *  
Public function Const const TArray< FImposedCuttingPoint > &  
Public function TSharedRef< FTopologicalEdge >  
Public function Const TSharedRef< const FTopologicalEdge >  
Public function Const TArray< FTopologicalFace * >  
Public function Const const FTopologicalLoop *

GetLoop ()

  
Public function FTopologicalLoop *

GetLoop ()

  
Public function Const const FEdgeMesh *

GetMesh ()

  
Public function FEdgeMesh &

GetOrCreateMesh ( FModelMesh& MeshModel
)

  
Public function Const const FTopologicalVertex *  
Public function Const const TSharedPtr< FTopologicalVertex >  
Public function FTopologicalVertex *  
Public function TSharedPtr< FTopologicalVertex >  
Public function Const TArray< double > Compute the lengths of each pre-elements of the edge i.e the elements based of the cutting points of the edges.
Public function Const const FTopologicalEdge *  
Public function FTopologicalEdge *  
Public function FPoint  
Public function FPoint  
Public function Const double  
Public function Const const TSharedRef< FTopologicalVertex >  
Public function TSharedRef< FTopologicalVertex >  
Public function Const const TSharedRef< FTopologicalVertex >  
Public function Const const TSharedRef< FTopologicalVertex >

GetStartVertex ( bool Forward
)

  
Public function Const FPoint2D

GetTangent2DAt ( const double InCoordinate
)

  
Public function FPoint2D

GetTangent2DAt ( const FTopologicalVertex& InVertex
)

  
Public function FPoint

GetTangentAt ( const FTopologicalVertex& InVertex
)

 Return the tangent at the input vertex
Public function Const FPoint

GetTangentAt ( const double InCoordinate
)

  
Public function Const void

GetTangentsAtExtremities ( FPoint& StartTangent,
FPoint& EndTangent,
EOrientation Orientation
)

  
Public function Const void

GetTangentsAtExtremities ( FPoint& StartTangent,
FPoint& EndTangent,
bool bForward
)

  
Public function Const const TArray< FLinearBoundary > &  
Public function Const int32  
Public function Const const TArray< FThinZoneSide * > &  
Public function Const double

GetTolerance2DAt ( double Coordinate
)

  
Public function Const double  
Public function Const FTopologicalEdge *  
Public function Const bool

HasSameLengthAs ( const FTopologicalEdge& Edge,
double EdgeLengthTolerance
)

  
Public function void  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsLinkableTo ( const FTopologicalEdge& Edge,
double EdgeLengthTolerance
)

 It can be linked to the edge if :
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool An edge is a thin peak means that this edge is a small edge at the extremity of a peak thin zone So this edge must not be meshed (except at its extremities) ThinSide 0
Public function Const bool  
Public function Const double

Length ()

  
Public function void

Link ( FTopologicalEdge& OtherEdge
)

 Link with the other edge.
Public function void

LinkIfCoincident ( FTopologicalEdge& OtherEdge,
double EdgeLengthTolerance,
double SquareJoiningTolerance
)

 Link two edges.
Public function void  
Public function Static TSharedPtr< FTopologicalEdge >

Make ( const TSharedRef< FSurface >& InSurface,
const FPoint2D& InCoordinateVertex1,
const TSharedRef< FTopologicalVertex >& InVertex1,
const FPoint2D& InCoordinateVertex2,
const TSharedRef< FTopologicalVertex >& InVertex2
)

 Build an edge to connect two vertices carried by a 2d segment
Public function Static TSharedPtr< FTopologicalEdge >

Make ( const TSharedRef< FRestrictionCurve >& InCurve,
const TSharedRef< FTopologicalVertex >& InVertex1,
const TSharedRef< FTopologicalVertex >& InVertex2,
const FLinearBoundary& InBoundary
)

  
Public function Static TSharedPtr< FTopologicalEdge >

Make ( const TSharedRef< FRestrictionCurve >& InCurve,
const TSharedRef< FTopologicalVertex >& InVertex1,
const TSharedRef< FTopologicalVertex >& InVertex2
)

  
Public function Static TSharedPtr< FTopologicalEdge >

Make ( const TSharedRef< FRestrictionCurve >& InCurve
)

  
Public function Static TSharedPtr< FTopologicalEdge >

Make ( const TSharedRef< FRestrictionCurve >& InCurve,
const FLinearBoundary& InBoundary
)

  
Public function void

Offset2D ( const FPoint2D& OffsetDirection
)

  
Public function Const double

ProjectPoint ( const PointType& InPointToProject,
PointType& OutProjectedPoint
)

 Project Point (2D or 3D) on the polyline (2D or 3D) and return the coordinate of the projected point
Public function Const void

ProjectPoints ( const TArray< FPoint >& InPointsToProject,
TArray< double >& OutProjectedPointCoords,
TArray< FPoint >& OutProjectedPoints
)

 Project a set of points on the 3D polyline and return the coordinate of the projected point
Public function Const void

ProjectTwinEdgePoints ( const TArray< FPoint >& InPointsToProject,
bool bSameOrientation,
TArray< double >& OutProjectedPointCoords
)

 Project a set of points of a twin edge on the 3D polyline and return the coordinate of the projected point
Public function void

ProjectTwinEdgePointsOn2DCurve ( const TSharedRef< FTopologicalEdge >& InTwinEdge,
const TArray< double >& InTwinEdgePointCoords,
TArray< FPoint2D >& OutPoints2D
)

 Compute 2D points of the edge coincident the points of the twin edge defined by their coordinates
Public function void If the mesh of the edge is not built, Empty the CuttingPoints This allows to recompute a new discretization of the mesh based among other things on a new imposed cutting points (mesh of thin zone process)
Public function void

ReplaceEdgeVertex ( bool bIsStartVertex,
TSharedRef< FTopologicalVertex >& NewVertex
)

 This function is used to :
Public function Virtual Const void  
Public function Virtual Const void  
Public function Static TSharedPtr< FTopologicalEdge >

ReturnIfValid ( TSharedRef< FTopologicalEdge >& InEdge,
bool bCheckVertices
)

 To check the build edge before returning it or return TSharedPtr() if the edge is not valid
Public function Const void

Sample ( const double DesiredSegmentLength,
TArray< double >& OutCoordinates
)

 Samples the curve with segments of a desired length
Public function void

SetEndVertex ( const double NewCoordinate,
const FPoint& NewPoint3D
)

  
Public function void

SetEndVertex ( const double NewCoordinate
)

  
Public function void

SetStartVertex ( const double NewCoordinate
)

  
Public function void

SetStartVertex ( const double NewCoordinate,
const FPoint& NewPoint3D
)

  
Public function Virtual Const void  
Public function Virtual Const void  
Public function void For thin zone purpose.
Public function FTopologicalVertex *

SplitAt ( double SplittingCoordinate,
const FPoint& NewVertexCoordinate,
bool bKeepStartVertexConnectivity,
TSharedPtr< FTopologicalEdge >& OutNewEdge
)

 Split the edge at input coordinate.
Public function void

TransferCuttingPointFromMeshedEdge ( bool bOnlyWithOppositeNode,
FAddCuttingPointFunc AddCuttingPoint
)

  
Public function Const void

TransformActiveEdgeCoordinatesToLocalCoordinates ( const TArray< double >& InActiveEdgeCoordinate,
TArray< double >& OutLocalCoordinate
)

  
Public function Const double

TransformActiveEdgeCoordinateToLocalCoordinate ( const double ActiveEdgeCoordinate
)

  
Public function Const void

TransformLocalCoordinatesToActiveEdgeCoordinates ( const TArray< double >& InLocalCoordinate,
TArray< double >& OutActiveEdgeCoordinate
)

  
Public function Const double

TransformLocalCoordinateToActiveEdgeCoordinate ( const double LocalCoordinate
)

  
Public function Const void

TransformTwinEdgeCoordinatesToLocalCoordinates ( const FTopologicalEdge& TwinEdge,
const TArray< double >& InActiveEdgeCoordinate,
TArray< double >& OutLocalCoordinate
)

  
Public function Const double

TransformTwinEdgeCoordinateToLocalCoordinate ( const FTopologicalEdge& TwinEdge,
const double InTwinCoordinate
)

  
Public function void

Unlink ()

 Remove the edge and the extremity vertices of the linked entity vs UnlinkTwinEntities delete only the edge link

Overridden from FEntity

  Type Name Description
Public function Virtual void

Empty ()

  
Public function Virtual Const EEntity  
Public function Virtual Const void  
Public function Virtual void Serialization of a FEntity.
Public function Virtual void

SpawnIdent ( FDatabase& Database
)

  

Overridden from FHaveStates

  Type Name Description
Public function Virtual Const bool Important note: A Degenerated Edge is used to close 2D boundary in case of degenerated surface to ensureCADKernel a closed boundary Specific process is done for the mesh of this kind of surface

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page