Struct: riferimento dei tipi struct

Tipi struct esposti dal modulo LCC4UnrealRuntime.

#include "Core/LCCStructure.h"

Gli struct marcati BlueprintType possono essere scomposti e composti in Blueprint con i nodi Break / Make.

Prestazioni

FRenderInfo

Parametri di prestazione comuni. Usato da ULCCComponentBase::Performance.

La caratteristica di progettazione di questo struct è che ogni valore è accompagnato da una casella di abilitazione. Mentre la casella non è spuntata viene usato il valore predefinito interno del plugin, e il valore inserito si applica solo dopo averla spuntata. Il Setter corrispondente sul Component imposta automaticamente la casella a true.

Metodi di supporto:

bool HasMaxDistanceLimit() const;      // se esiste un limite di distanza
bool HasMaxNumLimit() const;           // se esiste un limite di conteggio
bool NeedPreload() const;              // se serve il precaricamento
uint32 GetMaxDistance() const;         // distanza massima effettiva
uint32 GetMaxSplatNum() const;         // conteggio massimo effettivo
float GetLevelFactor() const;          // fattore di LOD effettivo
uint32 GetStartLevel() const;          // Level iniziale effettivo
uint32 GetEndLevel() const;            // Level finale effettivo
uint32 GetMaxCollisionDistance() const;
uint32 GetPreloadDistance() const;     // restituisce GetMaxDistance() + 35
bool GetIfUseFullLoad(uint32 SplatNum) const;   // se il conteggio indicato usa il caricamento completo
void Reset();                          // reimposta solo i campi dei valori, non le caselle di abilitazione

Due trappole facili:

• Reset() reimposta solo i campi dei valori (distanza, conteggio, Level, fattore) e non reimposta nessuna delle caselle di abilitazione b*, né bUseFullLoad e FullLoadSplatNum.
• FRenderInfo::GetPreloadDistance() restituisce GetMaxDistance() + 35, mentre la funzione omonima sul component, ULCCComponentBase::GetPreloadDistance(), restituisce il valore grezzo del campo. I due risultati sono diversi.

I Getter restituiscono il valore effettivo: mentre la casella non è spuntata restituiscono il valore predefinito interno, non il valore inserito in precedenza. Questo si confonde facilmente, e leggere il campo direttamente può dare un risultato diverso dalla chiamata al Getter.

Note d'uso:

• Modificare tramite il Setter sul Component è il percorso più semplice e non richiede di gestire manualmente la casella.
• Quando si modificano direttamente i campi dello struct, ricordare di impostare anche la casella a true, altrimenti nulla ha effetto.

// consigliato: usare il Setter, la casella viene gestita automaticamente
Component->SetMaxDistance(200);

// modificare il campo direttamente richiede di impostare la casella in autonomia
Component->Performance.bDistanceLimit = true;
Component->Performance.MaxDistance = 200;

FLCCRenderInfo

Parametri di prestazione specifici di LCC1. Usato da ULCCComponent::LCCPerformance.

Metodi di supporto:

float GetSortFactor() const;
bool GetIfAddExtraPreNodes() const;
void Reset();

Pagina correlata: ULCCComponent

Metainformazioni

FMetaInfoBase

Struct base delle metainformazioni, da cui ereditano sia FLCCMetaInfo sia FLCC2MetaInfo. Tipo di ritorno di ULCCComponentBase::GetMetaInfo.

Metodi di supporto:

bool IsValid() const;              // se le metainformazioni sono valide
void Reset();
bool IsRTK() const;                // se sono presenti informazioni geografiche RTK
FVector GetOffset() const;         // offset come FVector, restituisce un vettore nullo con un avviso quando gli elementi sono meno di 3
FVector3f GetScale();              // nota: non è const e non verifica il numero di elementi
EFileType GetFileType() const;     // enum del tipo di file
float GetVersion() const;          // versione come float
uint32 GetLevel0SplatNum() const;  // numero di splat del Level 0, in unità di diecimila

GetScale() e GetOffset() differiscono in robustezza: GetOffset() verifica il numero di elementi e restituisce un vettore nullo con un avviso quando sono meno di 3, mentre GetScale() indicizza direttamente i primi tre elementi e va fuori dai limiti quando Scale ha meno di 3 elementi.

IsRTK() decide in base a Epsg > 0 più un offset diverso da zero e guarda solo i dati. Non è equivalente a CanUseGeoPlace(), che richiede inoltre che bEnableGeoPlace sia abilitato e che il sistema di riferimento geografico sia creato.

Note d'uso:

• Leggerlo dopo il completamento del caricamento; i campi sono tutti a valori nulli mentre i dati non sono pronti.
• TotalSplats è la quantità totale dei dati. ULCCComponentBase::GetSplatNumber() restituisce esattamente questo campo, quindi i due sono lo stesso valore.

if (Component->CheckIfLoaded())
{
    const FMetaInfoBase Meta = Component->GetMetaInfo();

    UE_LOG(LogTemp, Log, TEXT("Name: %s"), *Meta.Name);
    UE_LOG(LogTemp, Log, TEXT("Levels: %d, total splats: %d"),
        Meta.TotalLevel, Meta.TotalSplats);
    UE_LOG(LogTemp, Log, TEXT("Level 0 splats: %u (ten thousand)"),
        Meta.GetLevel0SplatNum());
    UE_LOG(LogTemp, Log, TEXT("Has SH: %s"),
        Meta.GetFileType() == EFileType::Quality ? TEXT("yes") : TEXT("no"));

    if (Meta.IsRTK())
    {
        UE_LOG(LogTemp, Log, TEXT("EPSG: %d, offset: %s"),
            Meta.Epsg, *Meta.GetOffset().ToString());
    }
}

Blueprint come testo:

[Get Meta Info]
        Target = (LCC Component)
        │ Return Value ──┐
        ▼                │
[Break FMetaInfoBase] ◀──┘
        Name → [Print String]
        Total Splats → [Print String]
        Total Level → [Print String]

FLCCMetaInfo

Metainformazioni LCC1 complete, che eredita da FMetaInfoBase.

La condizione di IsValid() è più stringente rispetto alla classe base: TotalLevel, TotalSplats, CellLengthX, CellLengthY e IndexDataSize devono essere tutti maggiori di 0.

Metodi del bounding box (tutti restituiscono FBox, solo C++):

FVector2f GetCellLength() const;
int32 GetXNum() const;                    // numero di celle lungo X
int32 GetYNum() const;                    // numero di celle lungo Y
FBox GetVisibleBoundingBox() const;       // bounding box visibile
FBox GetScaleBox() const;
FBox GetEnvironmentScaleBox() const;
FBox GetEnvironmentVisibleBox() const;
FBox GetShcoef() const;                   // intervallo di valori delle armoniche sferiche
FBox GetEnvShcoef() const;
FBox GetNormal() const;
FBox GetEnvNormal() const;
FBox GetColor() const;
FVector2f GetOpacity() const;

FLCC2MetaInfo

Metainformazioni LCC2 complete, che eredita da FMetaInfoBase. Tipo di ritorno di ULCC2Component::GetMetaInfo2.

La condizione di IsValid() è che Files non sia vuoto.

Metodo di supporto:

FBox GetBounds() const;    // bounding box del nodo radice, già convertito in centimetri

A proposito di SHBands: decide lo stride degli slot delle armoniche sferiche, quindi ogni sorgente di dati all'interno dello stesso buffer di armoniche sferiche deve concordare. Un albero che mescola numeri di bande diversi adotta il più ampio. I formati a file singolo (.sog / .spz / .ply) leggono il numero esatto di bande dall'header del decoder; LCC2 non ha un concetto di bande per file ed è FileType a deciderlo, con Portable senza armoniche sferiche e Quality con 3 bande.

Risultato dei test dei raggi

FLCCSplat

Risultato del colpo di un test dei raggi. Usato dalle funzioni di test dei raggi di ULCCComponent.

FLCCSplat Hit;
if (LineTraceSingle(Start, End, Hit, false, 0.f, 0.f))
{
    // posizione del colpo
    const FVector HitPos = Hit.Location;
    // livello di dettaglio attualmente caricato in quel punto
    const int32 Level = Hit.NodeVector.Level;
}

Pagina correlata: Test dei raggi di ULCCComponent

FLCCVector

Coordinate del nodo, che individuano un nodo nell'octree.

Il costruttore parametrico e il costruttore di copia limitano i tre campi a valori non negativi, ma un'assegnazione diretta (scrivere i campi dopo la costruzione predefinita, oppure usare operator=) non applica alcun limite.

Metodi di supporto:

FString ToString() const;     // il formato è "X:%i,Y:%i,Level:%i"
void Reset();
static double Dist2D(const FLCCVector& A, const FLCCVector& B);

L'uguaglianza confronta solo X, Y e Level, non le informazioni interne sulla camera e gli altri campi a runtime.

Level indica se i dati attualmente visibili siano fini o grossolani; un valore più piccolo è più fine.

Bounding box

FBoundingBoxInfo

Informazioni del bounding box.

FBoundingBoxInfoWithName

Bounding box con nome, usato dall'elenco degli attributi nelle metainformazioni.

L'uguaglianza confronta solo Name.

Metainformazioni SOG

Questo gruppo di struct descrive le metainformazioni di un file .sog ed è prodotto dalle funzioni di analisi SOG di ULCCUtilLibrary.

FLCC2SogMeta

Struct principale delle metainformazioni SOG.

Metodo di supporto:

bool HasShN() const;    // se sono presenti armoniche sferiche di ordine superiore, equivalente a ShN.Files non vuoto

Note d'uso:

• Leggerlo con ParseSogMetaFromFile senza caricare i dati di rendering, a costo molto basso.
• Rivela il numero di punti e la situazione delle armoniche sferiche prima del caricamento, così la configurazione della qualità può essere decisa in anticipo.

FLCC2SogMeta Meta;
if (ULCCUtilLibrary::ParseSogMetaFromFile(Path, Meta))
{
    UE_LOG(LogTemp, Log, TEXT("Version: %d, count: %d, high-order SH: %s"),
        Meta.Version, Meta.Count, Meta.HasShN() ? TEXT("yes") : TEXT("no"));
}

FLCC2SogShN

Dati delle armoniche sferiche di ordine superiore.

Metodo di supporto: bool HasShN() const.

FLCC2SogImageData

Dati immagine SOG.

Altri sotto-struct

Gli struct seguenti contengono solo un elenco di file, alcuni con un codebook di quantizzazione:

Codebook è un TStaticArray<float, 256>, non è una UPROPERTY e non è visibile in Blueprint.

Nodi dell'octree

Questo gruppo di struct descrive l'octree di LCC2. Sono dati di basso livello che lo sviluppo ordinario non ha bisogno di toccare direttamente.

FTreeNode

Nodo dell'octree.

Metodo di supporto:

void ClearIterative();

Raccoglie ogni nodo in ampiezza e pulisce in ordine inverso, evitando uno stack overflow dovuto alla distruzione ricorsiva in un albero molto profondo. Chiamarlo prima che un FTreeNode gestito manualmente esca dallo scope.

FTreeNodeData

Contenitore dei dati del nodo, che segnala con dei booleani la presenza di ciascun tipo di dati.

FTreeNodeData3DGS

FTreeNodeDataMesh

FTreeNodeDataBVH

Vedere anche

• ULCCComponentBase: uso di FRenderInfo e FMetaInfoBase
• ULCCComponent: uso di FLCCSplat e FLCCRenderInfo
• ULCCUtilLibrary: le funzioni di analisi delle metainformazioni SOG
• Enum: i tipi enum usati in questi struct