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

#include <TopologicalShapeEntity.h>

+ Inheritance diagram for UE::CADKernel::FTopologicalShapeEntity:

Public Member Functions

virtual ~FTopologicalShapeEntity () override
 
virtual void Serialize (FCADKernelArchive &Ar) override
 
virtual void Empty () override
 
const FMetadataDictionaryGetMetaDataDictionary () const
 
void ExtractMetaData (TMap< FString, FString > &OutMetaData) const
 
virtual void CompleteMetaData ()=0
 
void CompleteMetaDataWithHostMetaData ()
 
virtual int32 FaceCount () const =0
 
virtual void GetFaces (TArray< FTopologicalFace * > &OutFaces)=0
 
virtual void PropagateBodyOrientation ()=0
 
FTopologicalShapeEntityGetHost ()
 
const FTopologicalShapeEntityGetHost () const
 
void SetHost (FTopologicalShapeEntity *Body)
 
virtual void Remove (const FTopologicalShapeEntity *)=0
 
void SetHostId (const int32 InHostId)
 
int32 GetHostId () const
 
void SetLayer (const int32 InLayerId)
 
void SetName (const FString &InName)
 
bool HasName () const
 
const TCHARGetName () const
 
void SetColorId (const uint32 &InColorId)
 
uint32 GetColorId () const
 
void SetMaterialId (const uint32 &InMaterialId)
 
uint32 GetMaterialId () const
 
void SetDisplayData (const uint32 &InColorId, const uint32 &InMaterialId)
 
void SetDisplayData (const FTopologicalShapeEntity &DisplayData)
 
void SetPatchId (int32 InPatchId)
 
int32 GetPatchId () const
 
- Public Member Functions inherited from UE::CADKernel::FTopologicalEntity
FIdent GetKioId () const
 
const bool IsApplyCriteria () const
 
virtual void SetApplyCriteriaMarker () const
 
virtual void ResetApplyCriteria ()
 
bool IsNotMeshable () const
 
bool IsMeshable () const
 
bool IsPreMeshed () const
 
bool IsMeshed () const
 
virtual void SetPreMeshedMarker ()
 
virtual void SetMeshedMarker ()
 
virtual void ResetPreMeshed ()
 
- Public Member Functions inherited from UE::CADKernel::FEntity
virtual ~FEntity ()
 
virtual void Delete ()
 
virtual EEntity GetEntityType () const =0
 
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

void ResetHost ()
 
- 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 ()
 

Friends

class FBody
 
class FModel
 
class FShell
 

Additional Inherited Members

- 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)
 
- Protected Attributes inherited from UE::CADKernel::FTopologicalEntity
FIdent CtKioId = 0
 
- Protected Attributes inherited from UE::CADKernel::FEntity
FIdent Id = 0
 
- Protected Attributes inherited from UE::CADKernel::FHaveStates
EHaveStates States
 
- Static Protected Attributes inherited from UE::CADKernel::FEntity
static const TCHARTypesNames []
 

Constructor & Destructor Documentation

◆ ~FTopologicalShapeEntity()

virtual UE::CADKernel::FTopologicalShapeEntity::~FTopologicalShapeEntity ( )
inlineoverridevirtual

Member Function Documentation

◆ CompleteMetaData()

virtual void UE::CADKernel::FTopologicalShapeEntity::CompleteMetaData ( )
pure virtual

◆ CompleteMetaDataWithHostMetaData()

void UE::CADKernel::FTopologicalShapeEntity::CompleteMetaDataWithHostMetaData ( )

◆ Empty()

virtual void UE::CADKernel::FTopologicalShapeEntity::Empty ( )
inlineoverridevirtual

◆ ExtractMetaData()

void UE::CADKernel::FTopologicalShapeEntity::ExtractMetaData ( TMap< FString, FString > &  OutMetaData) const
inline

◆ FaceCount()

virtual int32 UE::CADKernel::FTopologicalShapeEntity::FaceCount ( ) const
pure virtual

◆ GetColorId()

uint32 UE::CADKernel::FTopologicalShapeEntity::GetColorId ( ) const
inline

◆ GetFaces()

virtual void UE::CADKernel::FTopologicalShapeEntity::GetFaces ( TArray< FTopologicalFace * > &  OutFaces)
pure virtual

◆ GetHost() [1/2]

FTopologicalShapeEntity * UE::CADKernel::FTopologicalShapeEntity::GetHost ( )
inline

◆ GetHost() [2/2]

const FTopologicalShapeEntity * UE::CADKernel::FTopologicalShapeEntity::GetHost ( ) const
inline

◆ GetHostId()

int32 UE::CADKernel::FTopologicalShapeEntity::GetHostId ( ) const
inline

◆ GetMaterialId()

uint32 UE::CADKernel::FTopologicalShapeEntity::GetMaterialId ( ) const
inline

◆ GetMetaDataDictionary()

const FMetadataDictionary & UE::CADKernel::FTopologicalShapeEntity::GetMetaDataDictionary ( ) const
inline

◆ GetName()

const TCHAR * UE::CADKernel::FTopologicalShapeEntity::GetName ( ) const
inline

◆ GetPatchId()

int32 UE::CADKernel::FTopologicalShapeEntity::GetPatchId ( ) const
inline

◆ HasName()

bool UE::CADKernel::FTopologicalShapeEntity::HasName ( ) const
inline

◆ PropagateBodyOrientation()

virtual void UE::CADKernel::FTopologicalShapeEntity::PropagateBodyOrientation ( )
pure virtual

Each face of model is set by its orientation. This allow to make oriented mesh and to keep the face orientation in topological function. Marker2 of propagate face is set. It must be reset after the process

Implemented in UE::CADKernel::FBody, UE::CADKernel::FModel, UE::CADKernel::FShell, and UE::CADKernel::FTopologicalFace.

◆ Remove()

virtual void UE::CADKernel::FTopologicalShapeEntity::Remove ( const FTopologicalShapeEntity )
pure virtual

◆ ResetHost()

void UE::CADKernel::FTopologicalShapeEntity::ResetHost ( )
inlineprotected

Mandatory: The host must have remove this from his array

◆ Serialize()

virtual void UE::CADKernel::FTopologicalShapeEntity::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::FTopologicalEntity.

Reimplemented in UE::CADKernel::FBody, UE::CADKernel::FModel, UE::CADKernel::FShell, and UE::CADKernel::FTopologicalFace.

◆ SetColorId()

void UE::CADKernel::FTopologicalShapeEntity::SetColorId ( const uint32 InColorId)
inline

◆ SetDisplayData() [1/2]

void UE::CADKernel::FTopologicalShapeEntity::SetDisplayData ( const FTopologicalShapeEntity DisplayData)
inline

◆ SetDisplayData() [2/2]

void UE::CADKernel::FTopologicalShapeEntity::SetDisplayData ( const uint32 InColorId,
const uint32 InMaterialId 
)
inline

◆ SetHost()

void UE::CADKernel::FTopologicalShapeEntity::SetHost ( FTopologicalShapeEntity Body)
inline

◆ SetHostId()

void UE::CADKernel::FTopologicalShapeEntity::SetHostId ( const int32  InHostId)
inline

◆ SetLayer()

void UE::CADKernel::FTopologicalShapeEntity::SetLayer ( const int32  InLayerId)
inline

◆ SetMaterialId()

void UE::CADKernel::FTopologicalShapeEntity::SetMaterialId ( const uint32 InMaterialId)
inline

◆ SetName()

void UE::CADKernel::FTopologicalShapeEntity::SetName ( const FString &  InName)
inline

◆ SetPatchId()

void UE::CADKernel::FTopologicalShapeEntity::SetPatchId ( int32  InPatchId)
inline

Friends And Related Symbol Documentation

◆ FBody

friend class FBody
friend

◆ FModel

friend class FModel
friend

◆ FShell

friend class FShell
friend

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