UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::CADKernel::TLinkable< EntityType, LinkType > Class Template Reference

#include <Linkable.h>

+ Inheritance diagram for UE::CADKernel::TLinkable< EntityType, LinkType >:

Public Member Functions

 TLinkable ()=default
 
virtual ~TLinkable () override
 
void Finalize ()
 
virtual void Serialize (FCADKernelArchive &Ar) override
 
virtual void Empty () override
 
const TSharedRef< const EntityType > GetLinkActiveEntity () const
 
TSharedRef< EntityType > GetLinkActiveEntity ()
 
bool IsActiveEntity () const
 
void Activate ()
 
virtual TSharedPtr< LinkType > GetLink () const
 
virtual TSharedPtr< LinkType > GetLink ()
 
void ResetTopologicalLink ()
 
bool IsLinkedTo (const TSharedRef< EntityType > &Entity) const
 
bool IsLinkedTo (const EntityType &Entity) const
 
int32 GetTwinEntityCount () const
 
bool HasTwin () const
 
const TArray< EntityType * > & GetTwinEntities () const
 
virtual void RemoveFromLink ()
 
void UnlinkTwinEntities ()
 
const bool IsThinZone () const
 
virtual void SetThinZoneMarker ()
 
virtual void ResetThinZone ()
 
virtual void ResetMarkersRecursively () const override
 
- 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)
 
- 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 MakeLink (EntityType &Twin)
 
void SetTopologicalLink (TSharedPtr< LinkType > Link)
 
- 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

TSharedPtr< LinkType > TopologicalLink
 
- 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
 

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)
 
- Static Protected Attributes inherited from UE::CADKernel::FEntity
static const TCHARTypesNames []
 

Constructor & Destructor Documentation

◆ TLinkable()

template<typename EntityType , typename LinkType >
UE::CADKernel::TLinkable< EntityType, LinkType >::TLinkable ( )
default

◆ ~TLinkable()

template<typename EntityType , typename LinkType >
virtual UE::CADKernel::TLinkable< EntityType, LinkType >::~TLinkable ( )
inlineoverridevirtual

Member Function Documentation

◆ Activate()

template<typename EntityType , typename LinkType >
void UE::CADKernel::TLinkable< EntityType, LinkType >::Activate ( )
inline

◆ Empty()

template<typename EntityType , typename LinkType >
virtual void UE::CADKernel::TLinkable< EntityType, LinkType >::Empty ( )
inlineoverridevirtual

◆ Finalize()

template<typename EntityType , typename LinkType >
void UE::CADKernel::TLinkable< EntityType, LinkType >::Finalize ( )
inline

◆ GetLink() [1/2]

template<typename EntityType , typename LinkType >
virtual TSharedPtr< LinkType > UE::CADKernel::TLinkable< EntityType, LinkType >::GetLink ( )
inlinevirtual

◆ GetLink() [2/2]

template<typename EntityType , typename LinkType >
virtual TSharedPtr< LinkType > UE::CADKernel::TLinkable< EntityType, LinkType >::GetLink ( ) const
inlinevirtual

◆ GetLinkActiveEntity() [1/2]

template<typename EntityType , typename LinkType >
TSharedRef< EntityType > UE::CADKernel::TLinkable< EntityType, LinkType >::GetLinkActiveEntity ( )
inline

◆ GetLinkActiveEntity() [2/2]

template<typename EntityType , typename LinkType >
const TSharedRef< const EntityType > UE::CADKernel::TLinkable< EntityType, LinkType >::GetLinkActiveEntity ( ) const
inline

◆ GetTwinEntities()

template<typename EntityType , typename LinkType >
const TArray< EntityType * > & UE::CADKernel::TLinkable< EntityType, LinkType >::GetTwinEntities ( ) const
inline

◆ GetTwinEntityCount()

template<typename EntityType , typename LinkType >
int32 UE::CADKernel::TLinkable< EntityType, LinkType >::GetTwinEntityCount ( ) const
inline

◆ HasTwin()

template<typename EntityType , typename LinkType >
bool UE::CADKernel::TLinkable< EntityType, LinkType >::HasTwin ( ) const
inline

◆ IsActiveEntity()

template<typename EntityType , typename LinkType >
bool UE::CADKernel::TLinkable< EntityType, LinkType >::IsActiveEntity ( ) const
inline

◆ IsLinkedTo() [1/2]

template<typename EntityType , typename LinkType >
bool UE::CADKernel::TLinkable< EntityType, LinkType >::IsLinkedTo ( const EntityType &  Entity) const
inline

◆ IsLinkedTo() [2/2]

template<typename EntityType , typename LinkType >
bool UE::CADKernel::TLinkable< EntityType, LinkType >::IsLinkedTo ( const TSharedRef< EntityType > &  Entity) const
inline

◆ IsThinZone()

template<typename EntityType , typename LinkType >
const bool UE::CADKernel::TLinkable< EntityType, LinkType >::IsThinZone ( ) const
inline

◆ MakeLink()

template<typename EntityType , typename LinkType >
void UE::CADKernel::TLinkable< EntityType, LinkType >::MakeLink ( EntityType &  Twin)
inlineprotected

◆ RemoveFromLink()

template<typename EntityType , typename LinkType >
virtual void UE::CADKernel::TLinkable< EntityType, LinkType >::RemoveFromLink ( )
inlinevirtual

◆ ResetMarkersRecursively()

template<typename EntityType , typename LinkType >
virtual void UE::CADKernel::TLinkable< EntityType, LinkType >::ResetMarkersRecursively ( ) const
inlineoverridevirtual

Reimplemented from UE::CADKernel::FEntity.

Reimplemented in UE::CADKernel::FTopologicalEdge.

◆ ResetThinZone()

template<typename EntityType , typename LinkType >
virtual void UE::CADKernel::TLinkable< EntityType, LinkType >::ResetThinZone ( )
inlinevirtual

◆ ResetTopologicalLink()

template<typename EntityType , typename LinkType >
void UE::CADKernel::TLinkable< EntityType, LinkType >::ResetTopologicalLink ( )
inline

◆ Serialize()

template<typename EntityType , typename LinkType >
virtual void UE::CADKernel::TLinkable< EntityType, LinkType >::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::FTopologicalEdge, and UE::CADKernel::FTopologicalVertex.

◆ SetThinZoneMarker()

template<typename EntityType , typename LinkType >
virtual void UE::CADKernel::TLinkable< EntityType, LinkType >::SetThinZoneMarker ( )
inlinevirtual

◆ SetTopologicalLink()

template<typename EntityType , typename LinkType >
void UE::CADKernel::TLinkable< EntityType, LinkType >::SetTopologicalLink ( TSharedPtr< LinkType >  Link)
inlineprotected

◆ UnlinkTwinEntities()

template<typename EntityType , typename LinkType >
void UE::CADKernel::TLinkable< EntityType, LinkType >::UnlinkTwinEntities ( )
inline

Unlink all twin entities

Member Data Documentation

◆ TopologicalLink

template<typename EntityType , typename LinkType >
TSharedPtr<LinkType> UE::CADKernel::TLinkable< EntityType, LinkType >::TopologicalLink
mutableprotected

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