TStereoLayerManager

Navigation

API > API/Plugins > API/Plugins/XRBase

Inheritance Hierarchy

• IStereoLayers
• TStereoLayerManager
• FSimpleLayerManager
• FDefaultStereoLayers

References

Syntax

template<typename LayerType>  
class TStereoLayerManager : public IStereoLayers  
Copy full snippet

template<typename LayerType> class TStereoLayerManager : public IStereoLayers

Remarks

Partial implementation of the Layer management code for the IStereoLayers interface. Implements adding, deleting and updating layers regardless of how they are rendered.

A class that wishes to implement the IStereoLayer interface can extend this class instead. The template argument should be a type for storing layer data. It should have a constructor matching the following: LayerType(const FLayerDesc& InLayerDesc); ... and implement the following function overloads: void SetLayerId(uint32 InId), uint32 GetLayerId() const, bool GetLayerDescMember(LayerType& Layer, FLayerDesc& OutLayerDesc), void SetLayerDescMember(LayerType& Layer, const FLayerDesc& Desc), and void MarkLayerTextureForUpdate(LayerType& Layer)

To perform additional bookkeeping each time individual layers are changed, you can override the following protected method: UpdateLayer(LayerType& Layer, uint32 LayerId, bool bIsValid) It is called whenever CreateLayer, DestroyLayer, SetLayerDesc and MarkTextureForUpdate are called.

Simple implementations that do not to track additional data per layer may use FLayerDesc directly. The FSimpleLayerManager subclass can be used in that case and it implements all the required glue functions listed above.

To access the layer data from your subclass, you have the following protected interface: bool GetStereoLayersDirty() Returns true if layer data have changed since the status was last cleared ForEachLayer(...) pass in a lambda to iterate through each existing layer. CopyLayers(TArray& OutArray, bool bMarkClean = true) Copies the layers into OutArray. CopySortedLayers(TArray& OutArray, bool bMarkClean = true) Copies the layers into OutArray sorted by their priority. WithLayer(uint32 LayerId, TFunction Func) Finds the layer by Id and passes it to Func or nullptr if not found. The last two methods will clear the layer dirty flag unless you pass in false as the optional final argument.

Thread safety: Updates and the two protected access methods use a critical section to ensure atomic access to the layer structures. Therefore, it is probably better to copy layers before performing time consuming operations using CopyLayers and reserve ForEachLayer for simple processing or operations where you need to know the user-facing layer id. The WithLayer method is useful if you already know the id of a layer you need to access in a thread safe manner.

Constructors

Destructors

Functions