1. Epic GamesDeveloper
  3. FDatabase

FDatabase

API > API/Runtime > API/Runtime/CADKernel > API/Runtime/CADKernel/Core

References

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

Syntax

class FDatabase

Variables

  Type Name Description
Protected variable TArray< TSharedPtr< FEntity > > ArchiveEntities Array (use as a Map>) of all the entities of an archive Each Entity is at the index of AchiveId in the array
Protected variable TArray< TArray< FEntity ** > > ArchiveIdToWaitingPointers  
Protected variable TArray< TArray< TSharedPtr< FEntity > * > > ArchiveIdToWaitingSharedPointers Array (use as a MapTArray*>>) Some Entity reference an other Entities (with a TSharedPtr).
Protected variable TArray< TArray< TWeakPtr< FEntity > * > > ArchiveIdToWaitingWeakPointers  
Protected variable TArray< FIdent > AvailableIdents Recycling of the Id to avoid fragmented idents
Protected variable bool bForceSpawning  
Protected variable bool bIsRecursiveSerialization  
Protected variable TArray< TSharedPtr< FEntity > > DatabaseEntities Array (use as a Map>) of all the entities create during the session Each Entity.Id is the index of the entity in the array
Protected variable TSet< FIdent > EntitiesToBeSerialized Dedicated to SerializeSelection. Set of entity Ids needed to be saved
Protected variable uint32 EntityCount  
Protected variable TSharedPtr< FModel > Model Root Geometry Entity node
Protected variable TQueue< FIdent > NotYetSerialized Dedicated to SerializeSelection. Queue of entity Ids waiting to be saved

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddEntity ( TSharedPtr< FEntity > Entity
)

 All Entities are saved in the session map that allows to retrieve them according to their Id This process is automatically done during the entity creation (FEntity::MakeShared)
Public function void During the load of an FArchive: All Entities are saved in the session map (like Entity created in runtime) that allows to retrieve them according to their Id.
Protected function void

AddEntityToSave ( FIdent EntityId
)

 Dedicated method for SerializeSelection
Public function Const void

CadEntitiesSelection ( const TArray< TSharedPtr< FEntity > >& Entities,
TArray< TSharedPtr< FEntity > >& OutCadEntities
)

  
Public function void Method to clean entity descriptions i.e. removing invalid references (like unsaved linked edges of an edge because the neighbor topological face is not saved)
Public function void  
Public function void

Empty ()

 Delete all the entities of the session
Public function Const void

ExpandSelection ( const TArray< TSharedPtr< FEntity > >& Entities,
const TSet< EEntity >& Filter,
TArray< TSharedPtr< FEntity > >& OutSelection
)

  
Public function Const void

ExpandSelection ( const TArray< TSharedPtr< FEntity > >& Entities,
const TSet< EEntity >& Filter,
TSet< TSharedPtr< FEntity > >& OutSelection
)

  
Public function Const void

ExpandSelection ( TSharedPtr< FEntity > Entities,
const TSet< EEntity >& Filter,
TSet< TSharedPtr< FEntity > >& OutSelection
)

  
Public function Const void

GetEntities ( const TArray< FIdent >& ids,
TArray< FEntity* >& Entities
)

  
Public function Const void

GetEntities ( const TArray< FIdent >& ids,
TArray< TSharedPtr< FEntity > >& Entities
)

  
Public function Const void

GetEntitiesOfType ( EEntity Type,
TArray< TSharedPtr< FEntity > >& OutEntities
)

  
Public function Const void

GetEntitiesOfTypes ( const TSet< EEntity >& Types,
TArray< TSharedPtr< FEntity > >& OutEntities
)

  
Public function Const TSharedPtr< FEntity >

GetEntity ( FIdent id
)

 =========================================================================================================================================================================================================
Public function Const TSharedPtr< FEntity >  
Public function FModel &  
Public function TSharedPtr< FModel >  
Public function Const void

GetTopologicalEntities ( const TArray< FIdent >& ids,
TArray< FTopologicalEntity* >& Entities
)

  
Public function Const void  
Public function Const void

MeshEntitiesSelection ( const TArray< TSharedPtr< FEntity > >& Entities,
TArray< TSharedPtr< FEntity > >& OutMeshEntities
)

  
Public function void

RemoveEntity ( FIdent idEntity
)

 Remove from database
Public function void

RemoveEntity ( FEntity& Entity
)

  
Public function void All entities of the session are saved in the archive
Public function void

SerializeSelection ( FCADKernelArchive& Ar,
const TArray< FIdent >& SelectionIds
)

 Recursive serialization of a selection.
Public function void Find TSharedPtr associate to an Archive Id If the Entity is not yet created, add the entity in the waiting list
Public function void Find TWeakPtr associate to an Archive Id If the Entity is not yet created, add the entity in the waiting list
Public function void Find FEntity* associate to an Archive Id If the Entity is not yet created, add the entity in the waiting list
Public function uint32

SpawnEntityIdent ( FEntity& SelectedEntity,
bool bForceSpawning
)

  
Public function uint32

SpawnEntityIdents ( const TArray< TSharedPtr< FEntity > >& SelectedEntities,
bool bForceSpawning
)

  
Public function uint32

SpawnEntityIdents ( const TArray< FEntity* >& SelectedEntities,
bool bForceSpawning
)

  
Public function Const void

TopologicalEntitiesSelection ( const TArray< TSharedPtr< FEntity > >& Entities,
TArray< TSharedPtr< FTopologicalEntity > >& OutTopoEntities,
bool bFindSurfaces,
bool bFindEdges,
bool bFindVertices
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page