UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::CADKernel::FPlaneSurface Class Reference

#include <PlaneSurface.h>

+ Inheritance diagram for UE::CADKernel::FPlaneSurface:

Public Member Functions

virtual void Serialize (FCADKernelArchive &Ar) override
 
ESurface GetSurfaceType () const
 
const FMatrixHGetMatrix () const
 
FPlane GetPlane () const
 
virtual TSharedPtr< FEntityGeomApplyMatrix (const FMatrixH &InMatrix) const override
 
virtual void EvaluatePoint (const FVector2d &InSurfacicCoordinate, FSurfacicPoint &OutPoint3D, int32 InDerivativeOrder=0) const override
 
virtual void EvaluatePoints (const TArray< FVector2d > &InSurfacicCoordinates, TArray< FSurfacicPoint > &OutPoint3D, int32 InDerivativeOrder=0) const override
 
virtual void EvaluatePointGrid (const FCoordinateGrid &Coordinates, FSurfacicSampling &OutPoints, bool bComputeNormals=false) const override
 
virtual FVector ProjectPoint (const FVector &InPoint, FVector *OutProjectedPoint=nullptr) const
 
virtual void ProjectPoints (const TArray< FVector > &InPoints, TArray< FVector > *OutProjectedPointCoordinates, TArray< FVector > *OutProjectedPoints=nullptr) const
 
virtual void Presample (const FSurfacicBoundary &InBoundaries, FCoordinateGrid &OutCoordinates) override
 
virtual void IsSurfaceClosed (bool &bOutClosedAlongU, bool &bOutClosedAlongV) const override
 
- Public Member Functions inherited from UE::CADKernel::FSurface
virtual void ValidateUVPoints (TArray< FVector2d > &UVPoints) const
 
virtual ~FSurface ()=default
 
virtual EEntity GetEntityType () const override
 
const FSurfacicBoundaryGetBoundary () const
 
void TrimBoundaryTo (const FSurfacicBoundary NewLimit)
 
void ExtendBoundaryTo (const FSurfacicBoundary MaxLimit)
 
const FSurfacicToleranceGetIsoTolerances () const
 
double GetIsoTolerance (EIso Iso) const
 
double Get3DTolerance () const
 
virtual void EvaluatePoints (const TArray< FCurvePoint2D > &InSurfacicCoordinates, TArray< FSurfacicPoint > &OutPoint3D, int32 InDerivativeOrder=0) const
 
virtual void EvaluatePoints (const TArray< FCurvePoint2D > &InSurfacicCoordinates, TArray< FCurvePoint > &OutPoint3D, int32 InDerivativeOrder=0) const
 
virtual void EvaluatePoints (FSurfacicPolyline &Polyline) const
 
virtual void EvaluatePoints (const TArray< FCurvePoint2D > &Points2D, FSurfacicPolyline &Polyline) const
 
virtual FVector2d EvaluatePointInCylindricalSpace (const FVector2d &InSurfacicCoordinate) const
 
virtual void EvaluatePointGridInCylindricalSpace (const FCoordinateGrid &Coordinates, TArray< FVector2d > &) const
 
void EvaluateGrid (FGrid &Grid) const
 
virtual void EvaluateNormals (const TArray< FVector2d > &Points2D, TArray< FVector3f > &Normals) const
 
virtual void EvaluatePointAndNormal (const FVector2d &InPoint2D, FVector &Point, FVector3f &Normal) const
 
virtual FVector EvaluateNormal (const FVector2d &InPoint2D) const
 
void Sample (const FSurfacicBoundary &Bounds, int32 NumberOfSubdivisions[2], FSurfacicSampling &OutPointSampling) const
 
void Sample (const FSurfacicBoundary &Boundary, int32 NumberOfSubdivisions[2], FCoordinateGrid &OutCoordinateSampling) const
 
virtual void LinesNotDerivables (const FSurfacicBoundary &Bounds, int32 InDerivativeOrder, FCoordinateGrid &OutNotDerivableCoordinates) const
 
void LinesNotDerivables (int32 InDerivativeOrder, FCoordinateGrid &OutNotDerivableCoordinates) const
 
void PresampleIsoCircle (const FSurfacicBoundary &InBoundaries, FCoordinateGrid &Coordinates, EIso Iso)
 
- Public Member Functions inherited from UE::CADKernel::FEntityGeom
 FEntityGeom ()=default
 
FIdent GetKioId () const
 
- Public Member Functions inherited from UE::CADKernel::FEntity
virtual ~FEntity ()
 
virtual void Delete ()
 
virtual void Empty ()
 
bool IsTopologicalEntity () const
 
bool IsTopologicalShapeEntity () const
 
bool IsGeometricalEntity ()
 
const TCHARGetTypeName () const
 
const FIdentGetId () const
 
virtual void SpawnIdent (FDatabase &Database)
 
virtual void ResetMarkersRecursively () const
 
- Public Member Functions inherited from TSharedFromThis< FEntity >
TSharedRef< FEntity, Mode > AsShared ()
 
TSharedRef< FEntity const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< FEntity, Mode > AsWeak ()
 
TWeakPtr< FEntity const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 
- Public Member Functions inherited from UE::CADKernel::FHaveStates
 FHaveStates ()
 
void Serialize (FCADKernelArchive &Ar)
 
void ResetElementStatus ()
 
bool HasMarker1 () const
 
bool HasMarker2 () const
 
bool HasMarker1And2 () const
 
bool HasMarker1Or2 () const
 
void SetMarker1 () const
 
void SetMarker2 () const
 
void ResetMarker1 () const
 
void ResetMarker2 () const
 
void ResetMarkers () const
 
bool IsDeleted () const
 
void SetDeletedMarker () const
 
void ResetDeleted () const
 
virtual bool IsDeletedOrDegenerated () const
 
virtual bool IsDegenerated () const
 
virtual void SetAsDegenerated () const
 
virtual void ResetDegenerated () const
 
void SetWaitingMarker () const
 
void ResetWaitingMarker () const
 
virtual bool IsWaiting () const
 
void SetProcessedMarker () const
 
void ResetProcessedMarker () const
 
virtual bool IsProcessed () const
 
virtual bool IsProcessedDeletedOrDegenerated () const
 
void SetToProcessMarker () const
 
void ResetToProcessMarker () const
 
virtual bool IsToProcess () const
 
virtual bool IsNotToProcess () const
 
virtual bool IsNotToOrAlreadyProcess () const
 

Protected Member Functions

 FPlaneSurface (const double InToleranceGeometric, const FMatrixH &InMatrix, const FSurfacicBoundary &InBoundary)
 
 FPlaneSurface (const double InToleranceGeometric, double InDistanceFromOrigin, FVector InNormal, const FSurfacicBoundary &InBoundary)
 
 FPlaneSurface (const double InToleranceGeometric, const FVector &Position, FVector Normal, const FSurfacicBoundary &InBoundary)
 
 FPlaneSurface ()=default
 
void ComputeMinToleranceIso ()
 
- Protected Member Functions inherited from UE::CADKernel::FSurface
 FSurface ()=default
 
 FSurface (double InToleranceGeometric)
 
 FSurface (double InToleranceGeometric, const FSurfacicBoundary &InBoundary)
 
 FSurface (double InToleranceGeometric, double UMin, double UMax, double VMin, double VMax)
 
void ComputeDefaultMinToleranceIso ()
 
- Protected Member Functions inherited from UE::CADKernel::FEntity
bool SetId (FDatabase &Database)
 
- Protected Member Functions inherited from TSharedFromThis< FEntity >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Protected Attributes

FMatrixH Matrix
 
FMatrixH InverseMatrix
 
- Protected Attributes inherited from UE::CADKernel::FSurface
FSurfacicBoundary Boundary
 
double Tolerance3D
 
TCache< FSurfacicToleranceMinToleranceIso
 
- Protected Attributes inherited from UE::CADKernel::FEntityGeom
FIdent CtKioId = 0
 
- Protected Attributes inherited from UE::CADKernel::FEntity
FIdent Id = 0
 
- Protected Attributes inherited from UE::CADKernel::FHaveStates
EHaveStates States
 

Additional Inherited Members

- Static Public Member Functions inherited from UE::CADKernel::FSurface
static TSharedPtr< FSurfaceMakeBezierSurface (const double InToleranceGeometric, int32 InUDegre, int32 InVDegre, const TArray< FVector > &InPoles)
 
static TSharedPtr< FSurfaceMakeConeSurface (const double InToleranceGeometric, const FMatrixH &InMatrix, double InStartRadius, double InConeAngle, const FSurfacicBoundary &InBoundary)
 
static TSharedPtr< FSurfaceMakeCylinderSurface (const double InToleranceGeometric, const FMatrixH &InMatrix, const double InRadius, const FSurfacicBoundary &InBoundary)
 
static TSharedPtr< FSurfaceMakeNurbsSurface (const double InToleranceGeometric, const FNurbsSurfaceData &NurbsData)
 
static TSharedPtr< FSurfaceMakeNurbsSurface (const double InToleranceGeometric, const FNurbsSurfaceHomogeneousData &NurbsData)
 
static TSharedPtr< FSurfaceMakePlaneSurface (const double InToleranceGeometric, const FMatrixH &InMatrix, const FSurfacicBoundary &InBoundary)
 
static TSharedPtr< FSurfaceMakeSphericalSurface (const double InToleranceGeometric, const FMatrixH &InMatrix, double InRadius, const FSurfacicBoundary &InBoundary)
 
static TSharedPtr< FSurfaceMakeTorusSurface (const double InToleranceGeometric, const FMatrixH &InMatrix, double InMajorRadius, double InMinorRadius, const FSurfacicBoundary &InBoundary)
 
static TSharedPtr< FSurfaceDeserialize (FCADKernelArchive &Archive)
 
static double ComputeScaleAlongAxis (const FVector &InAxis, const FMatrixH &InMatrix, const FVector &InOrigin)
 
- Static Public Member Functions inherited from UE::CADKernel::FEntity
template<typename OtherEntity , typename... InArgTypes>
static TSharedRef< OtherEntity > MakeShared (InArgTypes &&... Args)
 
template<typename OtherEntity >
static TSharedRef< OtherEntity > MakeShared (FCADKernelArchive &Archive)
 
static void SerializeIdent (FCADKernelArchive &Ar, TSharedPtr< FEntity > &Entity, bool bSaveSelection=true)
 
static void SerializeIdent (FCADKernelArchive &Ar, TWeakPtr< FEntity > &Entity, bool bSaveSelection=true)
 
static void SerializeIdent (FCADKernelArchive &Ar, FEntity **Entity, bool bSaveSelection=true)
 
template<typename EntityType >
static void SerializeIdent (FCADKernelArchive &Ar, EntityType **Entity, bool bSaveSelection=true)
 
template<typename EntityType >
static void SerializeIdent (FCADKernelArchive &Ar, TSharedPtr< EntityType > &Entity, bool bSaveSelection=true)
 
template<typename EntityType >
static void SerializeIdent (FCADKernelArchive &Ar, TWeakPtr< EntityType > &Entity, bool bSaveSelection=true)
 
static void SerializeIdents (FCADKernelArchive &Ar, TArray< FEntity * > &Array, bool bSaveSelection=true)
 
static void SerializeIdents (FCADKernelArchive &Ar, TArray< TWeakPtr< FEntity > > &Array, bool bSaveSelection=true)
 
static void SerializeIdents (FCADKernelArchive &Ar, TArray< TSharedPtr< FEntity > > &Array, bool bSaveSelection=true)
 
static void SerializeIdents (FCADKernelArchive &Ar, TArray< TOrientedEntity< FEntity > > &Array)
 
template<typename EntityType >
static void SerializeIdents (FCADKernelArchive &Ar, TArray< EntityType * > &Array, bool bSaveSelection=true)
 
template<typename EntityType >
static void SerializeIdents (FCADKernelArchive &Ar, TArray< TWeakPtr< EntityType > > &Array, bool bSaveSelection=true)
 
template<typename EntityType >
static void SerializeIdents (FCADKernelArchive &Ar, TArray< TSharedPtr< EntityType > > &Array, bool bSaveSelection=true)
 
static void SpawnIdentOnEntities (TArray< FEntity * > &Array, FDatabase &Database)
 
static void SpawnIdentOnEntities (TArray< TSharedPtr< FEntity > > &Array, FDatabase &Database)
 
static void SpawnIdentOnEntities (TArray< TOrientedEntity< FEntity > > &Array, FDatabase &Database)
 
template<typename EntityType >
static void SpawnIdentOnEntities (TArray< TSharedPtr< EntityType > > &Array, FDatabase &Database)
 
static void ResetMarkersRecursivelyOnEntities (const TArray< FEntity * > &Array)
 
static void ResetMarkersRecursivelyOnEntities (const TArray< TWeakPtr< FEntity > > &Array)
 
static void ResetMarkersRecursivelyOnEntities (const TArray< TSharedPtr< FEntity > > &Array)
 
static void ResetMarkersRecursivelyOnEntities (const TArray< TOrientedEntity< FEntity > > &Array)
 
template<typename EntityType >
static void ResetMarkersRecursivelyOnEntities (const TArray< TSharedPtr< EntityType > > &Array)
 
static TSharedPtr< FEntityDeserialize (FCADKernelArchive &Ar)
 
static const TCHARGetTypeName (EEntity Type)
 
- Static Protected Member Functions inherited from TSharedFromThis< FEntity >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 
- Static Protected Attributes inherited from UE::CADKernel::FEntity
static const TCHARTypesNames []
 

Constructor & Destructor Documentation

◆ FPlaneSurface() [1/4]

UE::CADKernel::FPlaneSurface::FPlaneSurface ( const double  InToleranceGeometric,
const FMatrixH InMatrix,
const FSurfacicBoundary InBoundary 
)
protected

The plane surface is the plane XY. The surface is placed at its final position and orientation by the Matrix

◆ FPlaneSurface() [2/4]

UE::CADKernel::FPlaneSurface::FPlaneSurface ( const double  InToleranceGeometric,
double  InDistanceFromOrigin,
FVector  InNormal,
const FSurfacicBoundary InBoundary 
)
inlineprotected

The plane surface is the plane XY. The surface is placed at its final position and orientation by the Matrix, The matrix is calculated from the normal plane at its final position and its distance from the origin along the normal.

◆ FPlaneSurface() [3/4]

UE::CADKernel::FPlaneSurface::FPlaneSurface ( const double  InToleranceGeometric,
const FVector Position,
FVector  Normal,
const FSurfacicBoundary InBoundary 
)
protected

The plane surface is the plane XY. The surface is placed at its final position and orientation by the Matrix The matrix is calculated from the plan origin at its final position and its final normal

◆ FPlaneSurface() [4/4]

UE::CADKernel::FPlaneSurface::FPlaneSurface ( )
protecteddefault

Member Function Documentation

◆ ApplyMatrix()

TSharedPtr< FEntityGeom > UE::CADKernel::FPlaneSurface::ApplyMatrix ( const FMatrixH InMatrix) const
overridevirtual

◆ ComputeMinToleranceIso()

void UE::CADKernel::FPlaneSurface::ComputeMinToleranceIso ( )
inlineprotected

◆ EvaluatePoint()

void UE::CADKernel::FPlaneSurface::EvaluatePoint ( const FVector2d InSurfacicCoordinate,
FSurfacicPoint OutPoint3D,
int32  InDerivativeOrder = 0 
) const
overridevirtual

◆ EvaluatePointGrid()

void UE::CADKernel::FPlaneSurface::EvaluatePointGrid ( const FCoordinateGrid Coordinates,
FSurfacicSampling OutPoints,
bool  bComputeNormals = false 
) const
overridevirtual

Reimplemented from UE::CADKernel::FSurface.

◆ EvaluatePoints()

void UE::CADKernel::FPlaneSurface::EvaluatePoints ( const TArray< FVector2d > &  InSurfacicCoordinates,
TArray< FSurfacicPoint > &  OutPoint3D,
int32  InDerivativeOrder = 0 
) const
overridevirtual

Reimplemented from UE::CADKernel::FSurface.

◆ GetMatrix()

const FMatrixH & UE::CADKernel::FPlaneSurface::GetMatrix ( ) const
inline

◆ GetPlane()

FPlane UE::CADKernel::FPlaneSurface::GetPlane ( ) const

◆ GetSurfaceType()

ESurface UE::CADKernel::FPlaneSurface::GetSurfaceType ( ) const
inlinevirtual

◆ IsSurfaceClosed()

virtual void UE::CADKernel::FPlaneSurface::IsSurfaceClosed ( bool bOutClosedAlongU,
bool bOutClosedAlongV 
) const
inlineoverridevirtual

A surface is closed along an iso axis if it's connected to itself e.g. the edge carried by the iso curve U = UMin is linked to the edge carried by the iso curve U = UMax A complete sphere, torus are example of surface closed along U and V A cylinder with circle section or a cone are example of surface closed along an iso

Reimplemented from UE::CADKernel::FSurface.

◆ Presample()

virtual void UE::CADKernel::FPlaneSurface::Presample ( const FSurfacicBoundary InBoundaries,
FCoordinateGrid OutCoordinates 
)
inlineoverridevirtual

Generate a pre-sampling of the surface saved in OutCoordinates. This sampling is light enough to allow a fast computation of the grid, precise enough to compute accurately meshing criteria

Reimplemented from UE::CADKernel::FSurface.

◆ ProjectPoint()

FVector UE::CADKernel::FPlaneSurface::ProjectPoint ( const FVector InPoint,
FVector OutProjectedPoint = nullptr 
) const
virtual

◆ ProjectPoints()

void UE::CADKernel::FPlaneSurface::ProjectPoints ( const TArray< FVector > &  InPoints,
TArray< FVector > *  OutProjectedPointCoordinates,
TArray< FVector > *  OutProjectedPoints = nullptr 
) const
virtual

◆ Serialize()

virtual void UE::CADKernel::FPlaneSurface::Serialize ( FCADKernelArchive Ar)
inlineoverridevirtual

Serialization of a FEntity. Each class derived from FEntity has to override this method (and call the direct base class override method first) E.g. class FEntityXXX : public FEntityXX { virtual void Serialize(FCADKernelArchive& Ar) override { FEntityXX::Serialize(Ar); ... } }

Reimplemented from UE::CADKernel::FSurface.

Member Data Documentation

◆ InverseMatrix

FMatrixH UE::CADKernel::FPlaneSurface::InverseMatrix
protected

◆ Matrix

FMatrixH UE::CADKernel::FPlaneSurface::Matrix
protected

The documentation for this class was generated from the following files: