I3T

Appearance

Vp::DisplayOptions ​

Options specifying various display settings for rendering a scene. More...

#include "Viewport/data/DisplayOptions.h"

Public Functions ​

Name
DisplayOptions() =default
boolshouldDraw(const Entity & entity) const

Public Attributes ​

Name
std::array< glm::vec4, 6 >clippingPlanes
GridOptionsgrid
GridOptionslocalGrid
boolshowAxes
boolshowCamera
boolshowDefault
boolshowFrustum
boolshowGrids
boolshowTracking
booluserClipping

Detailed Description ​

cpp
class Vp::DisplayOptions;
class Vp::DisplayOptions;

Options specifying various display settings for rendering a scene.

Mainly which objects or their parts are displayed. DisplayOptions are passed to entities during rendering, unlike RenderOptions which mainly group options related to render targets.

Public Functions Documentation ​

function DisplayOptions ​

cpp
DisplayOptions() =default
DisplayOptions() =default

function shouldDraw ​

cpp
bool shouldDraw(
    const Entity & entity
) const
bool shouldDraw(
    const Entity & entity
) const

Public Attributes Documentation ​

variable clippingPlanes ​

cpp
std::array< glm::vec4, 6 > clippingPlanes;
std::array< glm::vec4, 6 > clippingPlanes;

variable grid ​

cpp
GridOptions grid;
GridOptions grid;

variable localGrid ​

cpp
GridOptions localGrid;
GridOptions localGrid;

variable showAxes ​

cpp
bool showAxes {true};
bool showAxes {true};

variable showCamera ​

cpp
bool showCamera {true};
bool showCamera {true};

variable showDefault ​

cpp
bool showDefault {true};
bool showDefault {true};

variable showFrustum ​

cpp
bool showFrustum {true};
bool showFrustum {true};

variable showGrids ​

cpp
bool showGrids {true};
bool showGrids {true};

variable showTracking ​

cpp
bool showTracking {false};
bool showTracking {false};

variable userClipping ​

cpp
bool userClipping {false};
bool userClipping {false};

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