Vp::FrustumObject

#include "Viewport/entity/FrustumObject.h"

Inherits from Vp::ColoredObject, Vp::GameObject, Vp::Entity

Public Functions

	Name
	FrustumObject(Core::Mesh * mesh, FrustumShader * shader)
virtual void	prepareRenderContext(RenderContext & context, const DisplayOptions & displayOptions) override
virtual void	render(const glm::mat4 & model, const glm::mat4 & view, const glm::mat4 & projection, const RenderContext & context) override<br>IMPLEMENTATION NOTE: Derived entity classes should expect a certain kind of shader and be able to directly static cast to it.

Public Attributes

	Name
glm::mat4	m_frustumProjectionViewMatrixInv
glm::mat4	m_frustumViewMatrixInv
bool	m_visualizeDepth
bool	m_vulkan <br>Determines the visualized depth range.

Additional inherited members

Public Functions inherited from Vp::ColoredObject

	Name
	ColoredObject(Core::Mesh * mesh, ColorShader * shader)
const glm::vec3 &	getColor() const
void	setColor(const glm::vec3 & color)
void	setColor(const glm::vec3 * color)

Public Attributes inherited from Vp::ColoredObject

	Name
glm::vec3	m_singleColor
bool	m_useSingleColor

Public Functions inherited from Vp::GameObject

	Name
	GameObject() =default<br>Creates an empty GameObject.
	GameObject(Core::Mesh * mesh, ObjectShader * shader)
virtual void	dispose() override
virtual void	update(Scene & scene) override

Public Attributes inherited from Vp::GameObject

	Name
Core::Mesh *	m_mesh
float	m_opacity

Public Classes inherited from Vp::Entity

	Name
struct	RenderContext

Public Types inherited from Vp::Entity

	Name
enum class	RenderType { NORMAL, CUSTOM, SILHOUETTE}

Public Functions inherited from Vp::Entity

	Name
	Entity()
virtual	~Entity() =default
RenderContext	createRenderContext(const DisplayOptions & displayOptions)
virtual void	dispose() =0
DisplayType	getDisplayType() const
glm::vec3	getHighlightColor() const
bool	isHighlighted() const
virtual void	onSceneAdd(Scene & scene)<br>Called when the entity is added to a scene.
virtual void	onSceneRemove(Scene & scene)<br>Called when the entity is removed from a scene.
void	setDisplayType(DisplayType type)
void	setHighlightColor(glm::vec3 highlightColor)
void	setHighlighted(bool highlight)
virtual void	update(Scene & scene) =0

Public Attributes inherited from Vp::Entity

	Name
bool	m_backFaceCull
unsigned int	m_explicitTransparencyOrder <br>Explicit order for ordered transparency.
bool	m_highlight <br>Whether to paint this entity with an outline, can be used for selection or just highlighting.
glm::vec3	m_highlightColor
bool	m_highlightUseDepth <br>Whether the highlight outline should respect the scene's depth buffer.
bool	m_ignoreReferenceSpace <br>When true, the "global"/"reference space" model matrix passed to viewport drawing methods is ignored.
bool	m_ignoreUserClipping <br>Whether to ignore user clip planes defined in DisplayOptions.
glm::mat4	m_lastModelMatrix <br>Potentially modifed model matrix last passed to the shader.
glm::mat4	m_modelMatrix <br>Model "world" transformation of the entity.
glm::mat4	m_modMatrix <br>Modification transformation, precedes any other transformations, modifies entity vertex data as if the modified data came directly from a source (model file).
bool	m_opaque
bool	m_selectable <br>Whether this entity should be written into the selection stencil buffer.
int	m_selectionId <br>Id of the object, -1 if not assigned, for selection purposes.
Shader *	m_shader
bool	m_visible
bool	m_wboit <br>Whether this entity should be rendered using order independent transparency, relevant if using a shader that supports wboit.
int	m_wboitFunc <br>Index of the weight function to be used in wboit.

Protected Attributes inherited from Vp::Entity

	Name
DisplayType	m_displayType

Public Functions Documentation

function FrustumObject

cpp

FrustumObject(
    Core::Mesh * mesh,
    FrustumShader * shader
)

FrustumObject(
    Core::Mesh * mesh,
    FrustumShader * shader
)

function prepareRenderContext

cpp

virtual void prepareRenderContext(
    RenderContext & context,
    const DisplayOptions & displayOptions
) override

virtual void prepareRenderContext(
    RenderContext & context,
    const DisplayOptions & displayOptions
) override

Reimplements: Vp::ColoredObject::prepareRenderContext

function render

cpp

virtual void render(
    const glm::mat4 & model,
    const glm::mat4 & view,
    const glm::mat4 & projection,
    const RenderContext & context
) override

virtual void render(
    const glm::mat4 & model,
    const glm::mat4 & view,
    const glm::mat4 & projection,
    const RenderContext & context
) override

IMPLEMENTATION NOTE: Derived entity classes should expect a certain kind of shader and be able to directly static cast to it.

Parameters:

model Implicit model matrix, multiplies the entity's model transform from the left.
view View matrix
projection Projection matrix
context Additional per-instance rendering parameters generated by createRenderContext() or prepareRenderContext().

Reimplements: Vp::Entity::render

Currently there is no error checking and wrongly passed shader type will CAUSE UNDEFINED BEHAVIOUR!

Using dynamic casts instead might be undesirable (slow) here (this might just be a premature optimalization) Generally the shader passed to this method is the m_shader of this entity. However we need functionality that allows us to change the shader temporarily (like for drawing silhouettes) Because of this the shader can also sometimes be something else, usually some derived type of the one the entity expects. I couldn't find a way to inform what kinds of shaders an entity is able to use in its render methods. The type of the shader must be the base Shader class and so some kind of casting must occur.

Another option could be to use some kind of a typeid/enum system that tells us what type a shader is (rather than use dynamic cast). But that approach ignores inheritance which we need and having multiple types of shaders and entity member variable seems very inflexible.

The true elegant solution probably doesn't involve inheritance at all and rather uses composition, together with an ECS or something. But it was decided to not dive into that realm and so we are stuck with this seemingly simple but not very flexible inheritance structure.

Public Attributes Documentation

variable m_frustumProjectionViewMatrixInv

cpp

glm::mat4 m_frustumProjectionViewMatrixInv {1.f};

glm::mat4 m_frustumProjectionViewMatrixInv {1.f};

variable m_frustumViewMatrixInv

cpp

glm::mat4 m_frustumViewMatrixInv {1.f};

glm::mat4 m_frustumViewMatrixInv {1.f};

variable m_visualizeDepth

cpp

bool m_visualizeDepth {false};

bool m_visualizeDepth {false};

variable m_vulkan

cpp

bool m_vulkan {false};

bool m_vulkan {false};

Determines the visualized depth range.

Updated on 2025-05-31 at 12:55:31 +0000

Vp::FrustumObject ​

Public Functions ​

Public Attributes ​

Additional inherited members ​

Public Functions Documentation ​

function FrustumObject ​

function prepareRenderContext ​

function render ​

Public Attributes Documentation ​

variable m_frustumProjectionViewMatrixInv ​

variable m_frustumViewMatrixInv ​

variable m_visualizeDepth ​

variable m_vulkan ​