Base Camera Entity for rendering scenes and views. More...

Inheritance diagram for VerticesEngine.vxCamera:

Classes
class	RenderMeshEntry
	An entry for the render mesh queue. This holds a reference to a vxModelMesh, a vxMaterial and any other render data that's required. More...

Public Member Functions
	vxCamera (vxGameplaySceneBase sceneBase)

virtual void	ResetCamera ()

override void	OnGraphicsRefresh ()
	Called when there is a reset or refresh of Graphic settings such as resolution or setting.

void	AddUICanvas (vxCanvas canvas)

void	Render ()

new T	CastAs< T > ()

Vector3	ProjectToScreenSpace (Vector3 WorldPosition)

Public Member Functions inherited from VerticesEngine.vxEntity
bool	HasSandboxOption (SandboxOptions option)

	vxEntity (vxGameplaySceneBase scene)
	Initializes a new instance of the VerticesEngine.Entities.vxEntity class. The Base Entity Object for the Engine.

virtual object	Clone ()
	Clones this Entity.

virtual void	OnNewItemAdded (string itmekey)

T	AddComponent< T > ()
	Add's a component to this entitiy.

T	GetComponent< T > ()
	Get's a component from the collection.

virtual void	GetPropertyInfo (vxPropertiesControl propertyControl)

virtual void	OnBeforeEntitySerialize ()
	A method which allows for certain opperations to be preformed just before the entity is saved to a file.

virtual void	OnAfterEntityDeserialized ()
	A method which allows for certain opperations to be preformed after the entity is loaded from a file.

T	CastAs< T > ()

Public Member Functions inherited from VerticesEngine.vxGameObject
virtual void	OnEnabled ()
	Called on Component Enabled.

virtual void	OnDisabled ()
	Called on Component Disabled.

virtual void	OnSelected ()
	Called when Selected.

virtual void	OnUnSelected ()
	Called when Unselected.

virtual string	GetTitle ()
	Gets the title.

virtual Texture2D	GetIcon (int w, int h)
	Gets the icon for this game object. Override this to provide per-entity cusomtization.

	vxGameObject ()
	Creates a new vxGameObject.

void	Dispose ()
	Dispposes this Object.

Public Attributes
Color	BackBufferColour = Color.Black
	What is the back colour for this camera.

vxCameraProjectionType	DefaultProjectionType = vxCameraProjectionType.Perspective

vxCameraProjectionType	EditorProjectionType = vxCameraProjectionType.Perspective

Matrix	InverseView

Matrix	InverseProjection

float	MinZoom = 0.02f

float	MaxZoom = 80000f

Vector3	OrbitTarget = Vector3.Zero
	The orbit target of the Camera in Orbit mode.

bool	CanTakeInput = true
	Whether or not the Camera should or can take input currently.

RenderMeshEntry[]	renderList = new RenderMeshEntry[MAX_DRAWLIST_SIZE]

RenderMeshEntry[]	selectedRenderList = new RenderMeshEntry[MAX_DRAWLIST_SIZE]

bool	IsRenderListEnabled = true

int	opaqueCount = 0

int	transparentCount = 0

int	selectedCount = 0

Rectangle	NormalisedBounds = new Rectangle(0, 0, 1, 1)
	This is the normalised bounds of where this camera is rendered too.

Public Attributes inherited from VerticesEngine.vxEntity
SandboxOptions	EntitySandboxOptions
	Options for this entity in the sandbox. I.e. is it saveable, is it cullable, etc...

bool	KeepUpdating = true
	Whether or not too keep Updating the current Entity.

bool	RenderEvenInDebug = false
	Should it be Rendered in Debug.

Public Attributes inherited from VerticesEngine.vxGameObject
bool	OnlySelectInSandbox = false

Protected Member Functions
virtual void	OnCameraTypeChanged ()
	Called when the Camera Type is Changed.

override void	OnDisposed ()
	Called when the entity is disposed.

Protected Member Functions inherited from VerticesEngine.vxEntity
void	AddSandboxOption (SandboxOptions option)

void	RemoveSandboxOption (SandboxOptions option)

virtual vxEntityRenderer	CreateRenderer ()

override void	OnVisibilityChanged ()
	Called when an Objects Visibility Changes.

virtual vxMaterial	OnMapMaterialToMesh (vxModelMesh mesh)
	Applies the materials to the a corresponding mesh in the mesh renderer.

virtual void	OnFirstUpdate ()

virtual void	MarkForDisposal ()

override void	OnDisposed ()
	Called when the entity is disposed.

Protected Member Functions inherited from VerticesEngine.vxGameObject
virtual bool	HasId ()

virtual void	OnSelectionStateChange ()
	Called when the selection state changes.

virtual string	GetIdPrefix ()

Properties
vxCameraType	CameraType `[get, set]`
	The type of the camera.

vxCameraProjectionType	ProjectionType `[get, set]`
	Gets or sets the type of the projection.

Viewport	Viewport `[get, set]`
	The viewport for this Camera.

Matrix	View `[get, set]`
	Gets or sets the view.

Matrix	Projection `[get, set]`
	Gets or sets the projection.

Matrix	ViewProjection `[get]`
	Gets the view projection.

Matrix	InverseViewProjection `[get]`
	Gets the invert view projection matrix.

Matrix	PreviousViewProjection `[get]`
	Gets the previous view projection matrix for use in Temporal Effects such as Camera Motion Blur.

BoundingFrustum	BoundingFrustum `[get]`

float	FieldOfView `[get, set]`
	Gets or sets the field of view of the camera in radians.

static float	DefaultFieldOfView `[get, set]`

float	AspectRatio `[get, set]`
	Gets or sets the aspect ratio.

float	NearPlane `[get, set]`
	Gets or sets the near plane.

float	FarPlane `[get, set]`
	Gets or sets the far plane.

Vector4	Util_VX_ProjectionParams `[get]`

float	Zoom `[get, set]`

float	OrbitZoom `[get, set]`
	Gets or sets the Requested orbit zoom factor.

float	ReqYaw `[get, set]`
	Gets or sets the requested yaw rotation of the camera.

float	ReqPitch `[get, set]`
	Gets or sets the requested pitch rotation of the camera.

Matrix	WorldMatrix `[get, set]`
	Gets the world transformation of the camera.

Vector3	Position `[get, set]`
	Position of camera in world space.

RenderTarget2D	FinalScene `[get]`
	Final scene for this camera.

vxEnumSceneDebugMode	SceneDebugDisplayMode `[get, set]`

virtual bool	IsUtilCamera `[get]`

Properties inherited from VerticesEngine.vxEntity
vxGameplaySceneBase	CurrentScene `[get]`
	Gets the current scene of the game.

List< vxComponent >	Components `[get]`
	List of Components attached to this Entity.

vxTransform	Transform `[get, set]`
	The transform for this entity.

BoundingSphere	BoundingShape `[get]`
	The Bounding Sphere which is used to do frustrum culling.

bool	IsEntityCullable `[get, set]`
	Should this entity be checked for culling. Items like the Sky box shouldn't ever be.

vxEntityRenderer	EntityRenderer `[get]`

Properties inherited from VerticesEngine.vxGameObject
bool	IsVisible `[get, set]`
	Is this Game Object currently visible? Note that an Object can be Enabled, but not visible.

bool	IsEnabled `[get, set]`
	Is this Game Object Enabled currently.

string	Id `[get, set]`
	A unqiue string id which allows references to items to be serialised between sessions.

Texture2D	DefaultTexture `[get]`
	Gets the default texture.

vxEnumSandboxStatus	SandboxState `[get]`
	State of the Entity which is triggered by the simulation.

vxSelectionState	SelectionState `[get, set]`
	Gets or sets the selection state.

vxSelectionState	PreviousSelectionState `[get]`
	Get's the previous selection state.

bool	IsDisposed `[get]`

Additional Inherited Members
Static Public Attributes inherited from VerticesEngine.vxGameObject
static List< string >	NameRegister = new List<string>()
	The name register.

Protected Attributes inherited from VerticesEngine.vxEntity
BoundingSphere	m_boundingSphere = new BoundingSphere()

Events inherited from VerticesEngine.vxGameObject
EventHandler< EventArgs >	Selected
	Event Fired when the Items Selection stat Changes too Hovered.

EventHandler< EventArgs >	UnSelected
	Event Fired when the Items Selection stat Changes too unselected (or unhovered)

Detailed Description

Base Camera Entity for rendering scenes and views.

Member Function Documentation

◆ CastAs< T >()

new T VerticesEngine.vxCamera.CastAs< T > ( )

Type Constraints

T

:

vxCamera

◆ OnCameraTypeChanged()

virtual void VerticesEngine.vxCamera.OnCameraTypeChanged ( )

protectedvirtual

Called when the Camera Type is Changed.

Reimplemented in VerticesEngine.vxCamera3D.

◆ OnDisposed()

override void VerticesEngine.vxCamera.OnDisposed ( )

protectedvirtual

Called when the entity is disposed.

Reimplemented from VerticesEngine.vxGameObject.

Reimplemented in VerticesEngine.vxUtilCamera3D.

◆ OnGraphicsRefresh()

override void VerticesEngine.vxCamera.OnGraphicsRefresh ( )

virtual

Called when there is a reset or refresh of Graphic settings such as resolution or setting.

Reimplemented from VerticesEngine.vxGameObject.

Reimplemented in VerticesEngine.vxCamera2D.

◆ ResetCamera()

virtual void VerticesEngine.vxCamera.ResetCamera ( )

virtual

Reimplemented in VerticesEngine.vxCamera2D.

Property Documentation

◆ AspectRatio

float VerticesEngine.vxCamera.AspectRatio

getset

Gets or sets the aspect ratio.

The aspect ratio.

◆ FarPlane

float VerticesEngine.vxCamera.FarPlane

getset

Gets or sets the far plane.

The far plane.

◆ FieldOfView

float VerticesEngine.vxCamera.FieldOfView

getset

Gets or sets the field of view of the camera in radians.

The field of view.

◆ InverseViewProjection

Matrix VerticesEngine.vxCamera.InverseViewProjection

get

Gets the invert view projection matrix.

The invert view projection.

◆ NearPlane

float VerticesEngine.vxCamera.NearPlane

getset

Gets or sets the near plane.

The near plane.

◆ OrbitZoom

float VerticesEngine.vxCamera.OrbitZoom

getset

Gets or sets the Requested orbit zoom factor.

The orbit zoom.

◆ PreviousViewProjection

Matrix VerticesEngine.vxCamera.PreviousViewProjection

get

Gets the previous view projection matrix for use in Temporal Effects such as Camera Motion Blur.

The previous view projection.

◆ Projection

Matrix VerticesEngine.vxCamera.Projection

getset

Gets or sets the projection.

The projection.

◆ ProjectionType

vxCameraProjectionType VerticesEngine.vxCamera.ProjectionType

getset

Gets or sets the type of the projection.

The type of the projection.

◆ View

Matrix VerticesEngine.vxCamera.View

getset

Gets or sets the view.

The view.

◆ ViewProjection

Matrix VerticesEngine.vxCamera.ViewProjection

get

Gets the view projection.

The view projection.

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

/github/workspace/src/VerticesEngine/src.shared/Cameras/vxCamera.cs

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CastAs< T >()

◆ OnCameraTypeChanged()

◆ OnDisposed()

◆ OnGraphicsRefresh()

◆ ResetCamera()

Property Documentation

◆ AspectRatio

◆ FarPlane

◆ FieldOfView

◆ InverseViewProjection

◆ NearPlane

◆ OrbitZoom

◆ PreviousViewProjection

◆ Projection

◆ ProjectionType

◆ View

◆ ViewProjection