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

#include <Session.h>

Public Member Functions

 FSession (double InGeometricTolerance)
 
FModelGetModel ()
 
TSharedPtr< FModelGetModelAsShared ()
 
void Serialize (FCADKernelArchive &Ar)
 
FDatabaseGetDatabase ()
 
void SetGeometricTolerance (double NewTolerance)
 
double GetGeometricTolerance () const
 
bool SaveDatabase (const TCHAR *FilePath)
 
void SaveDatabase (const TCHAR *FileName, const TArray< TSharedPtr< FEntity > > &Entities)
 
void SaveDatabase (const TCHAR *FileName, const TArray< FEntity * > &Entities)
 
void SaveDatabase (const TCHAR *FileName, FEntity &Entity)
 
void SaveDatabase (const TCHAR *FileName, const TSharedPtr< FEntity > Entity)
 
bool LoadDatabase (const TCHAR *FilePath)
 
bool SaveDatabase (TArray< uint8 > &Bytes)
 
bool LoadDatabase (const TArray< uint8 > &Bytes)
 
void AddDatabase (const TArray< uint8 > &InRawData)
 
void Clear ()
 
uint32 SpawnEntityIdent (FEntity &SelectedEntity, bool bForceSpawning=false)
 
uint32 SpawnEntityIdents (const TArray< TSharedPtr< FEntity > > &SelectedEntities, bool bForceSpawning=false)
 
uint32 SpawnEntityIdents (const TArray< FEntity * > &SelectedEntities, bool bForceSpawning=false)
 
int32 GetLastHostId () const
 
int32 NewHostId ()
 
void SetFirstNewHostId (int32 StartHostId)
 

Protected Attributes

double GeometricTolerance
 
FDatabase Database
 
int32 LastHostId
 

Friends

template<typename , ESPMode >
class SharedPointerInternals::TIntrusiveReferenceController
 

Constructor & Destructor Documentation

◆ FSession()

UE::CADKernel::FSession::FSession ( double  InGeometricTolerance)
inline

Member Function Documentation

◆ AddDatabase()

void UE::CADKernel::FSession::AddDatabase ( const TArray< uint8 > &  InRawData)

Add a database defined by a RawData in the current session database Entity ID is set for all loaded entities

◆ Clear()

void UE::CADKernel::FSession::Clear ( )
inline

◆ GetDatabase()

FDatabase & UE::CADKernel::FSession::GetDatabase ( )
inline

◆ GetGeometricTolerance()

double UE::CADKernel::FSession::GetGeometricTolerance ( ) const
inline

◆ GetLastHostId()

int32 UE::CADKernel::FSession::GetLastHostId ( ) const
inline

◆ GetModel()

FModel & UE::CADKernel::FSession::GetModel ( )
inline

◆ GetModelAsShared()

TSharedPtr< FModel > UE::CADKernel::FSession::GetModelAsShared ( )

◆ LoadDatabase() [1/2]

bool UE::CADKernel::FSession::LoadDatabase ( const TArray< uint8 > &  Bytes)

◆ LoadDatabase() [2/2]

bool UE::CADKernel::FSession::LoadDatabase ( const TCHAR FilePath)

Load and add a database in the current session database Entity ID is set for all loaded entities

◆ NewHostId()

int32 UE::CADKernel::FSession::NewHostId ( )
inline

◆ SaveDatabase() [1/6]

void UE::CADKernel::FSession::SaveDatabase ( const TCHAR FileName,
const TArray< FEntity * > &  Entities 
)

Save a selection and all the dependencies as a FAchive in a file Mandatory: all entity have to have a defined ID Use SpawnEntityIdent if needed

◆ SaveDatabase() [2/6]

void UE::CADKernel::FSession::SaveDatabase ( const TCHAR FileName,
const TArray< TSharedPtr< FEntity > > &  Entities 
)

Save a selection and all the dependencies as a FAchive in a file Mandatory: all entity have to have a defined ID Use SpawnEntityIdent if needed

◆ SaveDatabase() [3/6]

void UE::CADKernel::FSession::SaveDatabase ( const TCHAR FileName,
const TSharedPtr< FEntity Entity 
)
inline

Save a selection and all the dependencies as a FAchive in a file Mandatory: all entity have to have a defined ID Use SpawnEntityIdent if needed

◆ SaveDatabase() [4/6]

void UE::CADKernel::FSession::SaveDatabase ( const TCHAR FileName,
FEntity Entity 
)
inline

Save a selection and all the dependencies as a FAchive in a file Mandatory: all entity have to have a defined ID Use SpawnEntityIdent if needed

◆ SaveDatabase() [5/6]

bool UE::CADKernel::FSession::SaveDatabase ( const TCHAR FilePath)

Save the database as a FAchive in a file Mandatory: all entity have to have a defined ID Use SpawnEntityIdent if needed

◆ SaveDatabase() [6/6]

bool UE::CADKernel::FSession::SaveDatabase ( TArray< uint8 > &  Bytes)

◆ Serialize()

void UE::CADKernel::FSession::Serialize ( FCADKernelArchive Ar)
inline

◆ SetFirstNewHostId()

void UE::CADKernel::FSession::SetFirstNewHostId ( int32  StartHostId)
inline

For stitching purpose, stitching can generate new body needing a host id. To avoid duplicate, the first generated host id can be set.

◆ SetGeometricTolerance()

void UE::CADKernel::FSession::SetGeometricTolerance ( double  NewTolerance)

Tolerance must not be modified as soon as a geometric entity has been build.

◆ SpawnEntityIdent()

uint32 UE::CADKernel::FSession::SpawnEntityIdent ( FEntity SelectedEntity,
bool  bForceSpawning = false 
)
inline

To be consistent, all entity to save have to had an Id. This method browses all sub entities and set their Id if needed

Parameters
bForceSpawningIf false, the process does not iterate through the children of entities with a defined ID

◆ SpawnEntityIdents() [1/2]

uint32 UE::CADKernel::FSession::SpawnEntityIdents ( const TArray< FEntity * > &  SelectedEntities,
bool  bForceSpawning = false 
)
inline

◆ SpawnEntityIdents() [2/2]

uint32 UE::CADKernel::FSession::SpawnEntityIdents ( const TArray< TSharedPtr< FEntity > > &  SelectedEntities,
bool  bForceSpawning = false 
)
inline

Friends And Related Symbol Documentation

◆ SharedPointerInternals::TIntrusiveReferenceController

Member Data Documentation

◆ Database

FDatabase UE::CADKernel::FSession::Database
protected

◆ GeometricTolerance

double UE::CADKernel::FSession::GeometricTolerance
protected

◆ LastHostId

int32 UE::CADKernel::FSession::LastHostId
protected

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