class `render::DockOverlayRenderer`

Inherits: RendererExtension

Handles rendering of the dock overlay on the render thread.

Public

Constructors

DockOverlayRenderer

DockOverlayRenderer()

Private

Methods

Initialize

void Initialize(const Any &data) override

Called when the renderer extension is first initialized.

Check

RendererExtensionRequest Check(const Camera &camera) override

Returns true if the render() method should be called for the provided camera.

Render

void Render(const Camera &camera, const RendererViewContext &viewContext) override

Called at the point at which rendering should be performed for the provided camera.

Relevant render targets are guaranteed to be already bound to the render API, depending on the RenderLocation. Note that actual structure of the render targets depends on the active renderer.

camera: Camera through which the renderer is currently rendering.
viewContext: Additional information about the currently rendered view.

UpdateData

void UpdateData(const SPtr<Camera> &camera, const SPtr<Mesh> &mesh, bool active, DockManager::DockLocation location)

Updates the grid mesh to render.

camera: Camera to render the dock overlay to.
mesh: Overlay mesh to render.
active: Should the overlay be shown or not.
location: Highlighted location of the overlay.

Fields

mCamera

SPtr<Camera> mCamera

mMaterial

SPtr<Material> mMaterial

mMaterialParameterAdapter

SPtr<MaterialParameterAdapter> mMaterialParameterAdapter

mMesh

SPtr<Mesh> mMesh

mHighlightedDropLocation

DockManager::DockLocation mHighlightedDropLocation

mShowOverlay

bool mShowOverlay