bgi::Camera3D Struct Reference

3-D camera definition (Z-up, right-handed world coordinate system). More...

#include <bgi_types.h>

Data Fields
std::string	assignedSceneName {"default"}
	Name of the DDS scene graph this camera renders. Defaults to "default". Set with wxbgi_cam_set_scene().
struct {
int   count {3}
	number of circles (1..8) More...
bool   enabled {false}
float   innerRadius {25.f}
	world-unit radius of innermost circle More...
float   outerRadius {100.f}
	world-unit radius of outermost circle More...
}	concentricOverlay
	Concentric circles + crosshair overlay.
float	eyeX {0.f}
float	eyeY {-10.f}
float	eyeZ {5.f}
float	farPlane {10000.f}
float	fovYDeg {45.f}
bool	is2D {false}
float	nearPlane {0.1f}
float	orthoBottom {0.f}
float	orthoLeft {0.f}
float	orthoRight {0.f}
float	orthoTop {0.f}
float	pan2dX {0.f}
float	pan2dY {0.f}
CameraProjection	projection {CameraProjection::Orthographic}
float	rot2dDeg {0.f}
struct {
int   colorScheme {0}
	0 = blue, 1 = green, 2 = red More...
bool   enabled {false}
int   sizePx {8}
	square side length, pixels (2..16) More...
}	selCursorOverlay
	Selection cursor square overlay (moves with the mouse in this viewport).
float	targetX {0.f}
float	targetY {0.f}
float	targetZ {0.f}
float	upX {0.f}
float	upY {0.f}
float	upZ {1.f}
int	vpH {0}
int	vpW {0}
int	vpX {0}
int	vpY {0}
float	worldHeight2d {2.f}
	Visible world-units height used by 2-D cameras and auto-ortho.
float	zoom2d {1.f}

Detailed Description

3-D camera definition (Z-up, right-handed world coordinate system).

The camera stores both full 3-D eye/target/up parameters and a 2-D convenience layer (pan/zoom/rotation) for overhead/plan-view cameras. When is2D is true, the 2-D fields drive the view and projection matrices; otherwise the explicit 3-D and ortho fields are used.

All camera instances live in BgiState::cameras keyed by name. A camera named "default" is created automatically on initwindow() and replicates the classic BGI pixel-space coordinate system.

Field Documentation

assignedSceneName

std::string bgi::Camera3D::assignedSceneName {"default"}

Name of the DDS scene graph this camera renders. Defaults to "default". Set with wxbgi_cam_set_scene().

colorScheme

int bgi::Camera3D::colorScheme {0}

0 = blue, 1 = green, 2 = red

[struct]

struct { ... } bgi::Camera3D::concentricOverlay

Concentric circles + crosshair overlay.

count

int bgi::Camera3D::count {3}

number of circles (1..8)

enabled

bool bgi::Camera3D::enabled {false}

eyeX

float bgi::Camera3D::eyeX {0.f}

eyeY

float bgi::Camera3D::eyeY {-10.f}

eyeZ

float bgi::Camera3D::eyeZ {5.f}

farPlane

float bgi::Camera3D::farPlane {10000.f}

fovYDeg

float bgi::Camera3D::fovYDeg {45.f}

innerRadius

float bgi::Camera3D::innerRadius {25.f}

world-unit radius of innermost circle

is2D

bool bgi::Camera3D::is2D {false}

nearPlane

float bgi::Camera3D::nearPlane {0.1f}

orthoBottom

float bgi::Camera3D::orthoBottom {0.f}

orthoLeft

float bgi::Camera3D::orthoLeft {0.f}

orthoRight

float bgi::Camera3D::orthoRight {0.f}

orthoTop

float bgi::Camera3D::orthoTop {0.f}

outerRadius

float bgi::Camera3D::outerRadius {100.f}

world-unit radius of outermost circle

pan2dX

float bgi::Camera3D::pan2dX {0.f}

pan2dY

float bgi::Camera3D::pan2dY {0.f}

projection

CameraProjection bgi::Camera3D::projection {CameraProjection::Orthographic}

rot2dDeg

float bgi::Camera3D::rot2dDeg {0.f}

[struct]

struct { ... } bgi::Camera3D::selCursorOverlay

Selection cursor square overlay (moves with the mouse in this viewport).

sizePx

int bgi::Camera3D::sizePx {8}

square side length, pixels (2..16)

targetX

float bgi::Camera3D::targetX {0.f}

targetY

float bgi::Camera3D::targetY {0.f}

targetZ

float bgi::Camera3D::targetZ {0.f}

upX

float bgi::Camera3D::upX {0.f}

upY

float bgi::Camera3D::upY {0.f}

upZ

float bgi::Camera3D::upZ {1.f}

vpH

int bgi::Camera3D::vpH {0}

vpW

int bgi::Camera3D::vpW {0}

vpX

int bgi::Camera3D::vpX {0}

vpY

int bgi::Camera3D::vpY {0}

worldHeight2d

float bgi::Camera3D::worldHeight2d {2.f}

Visible world-units height used by 2-D cameras and auto-ortho.

zoom2d

float bgi::Camera3D::zoom2d {1.f}

---

The documentation for this struct was generated from the following file:

• src/bgi_types.h