Component attached to the player's camera rig. More...

Inheritance diagram for Chunks.Interface.CameraRig:

Public Member Functions
void	ScreenFade (Color dest, float duration)
	Fades the screen overlay color over a given duration in seconds. More...

IEnumerator	ScreenFadeCoroutine (Color dest, float duration)
	Coroutine to fades the screen overlay color over a given duration in seconds. More...

void	ResetClipPlanes ()
	Resents the near and far clip plane distances to their defaults. More...

void	ResetTransform ()
	Resets the scale to DefaultScale and centers the camera over DefaultOrigin. More...

void	ResetTransform (float scale, Vector origin)
	Resets the scale to scale and centers the camrea over origin . More...

void	ResetMenuPanelPositions ()

Public Member Functions inherited from Chunks.Entities.Component
void	DestroyComponent ()
	Removes this component from the entity that contains it. More...

void	DestroyEntity ()
	Removes the entity containing this component from the world, along with any child entities. More...

override string	ToString ()
	Returns a string representing this component with the format "TypeName (EntityName)." More...

Public Member Functions inherited from Chunks.Entities.Object
Entity	CreateChild ()
	Creates a new Entity parented to this one. More...

TComponent	CreateChildWithComponent< TComponent > ()
	Creates a new Entity parented to this one with a component of the given type, which is returned. More...

Entity	FindChild (string name, bool recurse=true)
	Attempts to find a child Entity of this one with the given name, and optionally searches recursively through all children. Null is returned if no matches are found. More...

TComponent	FindChildComponent< TComponent > (string name, bool recurse=true)
	Attempts to find a child Entity of this one with the given name, and optionally searches recursively through all children. If a matching Entity is found, a component of the given type is retrieved from it. Null is returned if no matches are found. More...

Entity	FindParent (string name)
	Attempts to find an Entity that contains this Object's Entity with the given Name. Returns null if no match is found. More...

TComponent	FindParentComponent< TComponent > ()
	Attempts to find an Entity that contains this Object's Entity with a component of the given type. If a matching Entity is found, the component of the given type is retrieved from it. Returns null if no match is found. More...

TComponent	FindParentComponent< TComponent > (string name)
	Attempts to find an Entity that contains this Object's Entity with the given Name. If a matching Entity is found, a component of the given type is retrieved from it. Returns null if no match is found. More...

TComponent	AddComponent< TComponent > ()
	Adds a component of the specified type to this entity, returning the new component. More...

TComponent	GetOrAddComponent< TComponent > ()
	Attempts to get a component of the specified type from this entity, adding it if one doesn't already exist. More...

TComponent	GetComponent< TComponent > ()
	Attempts to get a component of the specified type from this entity, returning null if one doesn't exist. More...

IEnumerable< TComponent >	GetComponents< TComponent > ()
	Gets all components derived from the given type. More...

Protected Member Functions
override void	OnInitialize ()
	Called only once, when the component is first attached to an entity and is ready to add or retrieve other components. More...

override void	OnUpdate ()
	Called once per world update if this component and its parent entity are enabled. More...

Protected Member Functions inherited from Chunks.Entities.Component
object	Wait (float timeSeconds)
	Suspends coroutine operation for the given time when yielded. More...

object	StartCoroutine (IEnumerator routine)
	Starts execution of a coroutine. More...

virtual void	OnSave (BinaryWriter writer)
	Implement this and OnLoad to enable serialization of this component when the parent entity saves. More...

virtual void	OnLoad (BinaryReader reader)
	Implement this and OnSave to enable serialization of this component when the parent entity saves. More...

virtual void	OnEnable ()
	Called each time this component goes from being disabled to enabled. More...

virtual void	OnDisable ()
	Called each time this component goes from being enabled to disabled. More...

virtual void	OnPhysicsUpdate ()
	Called at a fixed time step for any time dependant physics calculations. More...

virtual void	OnDestroy ()
	Called when this component is removed, or the parent entity is destroyed. More...

virtual void	OnPreRender ()
	Called just before the entity containing this component is rendered. More...

Properties
Entities.Transform	HeadTransform `[get, set]`
	Transformation of the head mounted display. More...

Vector	DefaultOrigin `[get, set]`
	Default local position to center the camera rig transform over when it is reset. More...

float	DefaultScale `[get, set]`
	Default local scale to reset the camera rig transform to. More...

MenuDock	MenuDock `[get]`

Color	ScreenOverlayColor `[get, set]`
	Overlay tint color, used for fading in and out. More...

float	NearClipPlane `[get, set]`
	Near clip plane distance of the camera. More...

float	FarClipPlane `[get, set]`
	Far clip plane distance of the camera. More...

Properties inherited from Chunks.Entities.Component
Entity	Entity `[get]`
	The entity this instance is attached to. More...

bool	IsSavingImplemented `[get]`
	If true, OnSave and OnLoad have been implemented for this type. More...

bool	Enabled `[get, set]`
	Enabled components will be updated, assuming they are within enabled entities. More...

Properties inherited from Chunks.Entities.Object
abstract bool	IsValid `[get]`
	Tests to see if this object hasn't been removed. More...

virtual string	Name `[get, set]`
	Custom name associated with this Object's Entity, used to find the Entity in the hierarchy. More...

virtual Transform	Transform `[get]`
	Transformation of this Object's Entity. More...

virtual IWorld	World `[get]`
	The IWorld that contains this Object. More...

Properties inherited from Chunks.Entities.IComponent
Entity	Entity `[get]`

bool	IsSavingImplemented `[get]`

bool	Enabled `[get, set]`

Properties inherited from Chunks.Entities.IObject
bool	IsValid `[get]`

string	Name `[get, set]`

Transform	Transform `[get]`

IWorld	World `[get]`

Additional Inherited Members
Public Attributes inherited from Chunks.Entities.Component
override bool	IsValid => Behaviour != null
	Tests to see if this component hasn't been removed. More...

Detailed Description

Component attached to the player's camera rig.

Member Function Documentation

override void Chunks.Interface.CameraRig.OnInitialize ( )

protectedvirtual

Called only once, when the component is first attached to an entity and is ready to add or retrieve other components.

Reimplemented from Chunks.Entities.Component.

override void Chunks.Interface.CameraRig.OnUpdate ( )

protectedvirtual

Called once per world update if this component and its parent entity are enabled.

Reimplemented from Chunks.Entities.Component.

void Chunks.Interface.CameraRig.ResetClipPlanes ( )

Resents the near and far clip plane distances to their defaults.

void Chunks.Interface.CameraRig.ResetMenuPanelPositions ( )

void Chunks.Interface.CameraRig.ResetTransform ( )

Resets the scale to DefaultScale and centers the camera over DefaultOrigin.

void Chunks.Interface.CameraRig.ResetTransform	(	float	scale,
		Vector	origin
	)

Resets the scale to scale and centers the camrea over origin .

Parameters

scale	Local scale
origin	Local position to center the camera over

void Chunks.Interface.CameraRig.ScreenFade	(	Color	dest,
		float	duration
	)

Fades the screen overlay color over a given duration in seconds.

Parameters

dest	Final color to fade to
duration	Duration to fade over, in seconds

IEnumerator Chunks.Interface.CameraRig.ScreenFadeCoroutine	(	Color	dest,
		float	duration
	)

Coroutine to fades the screen overlay color over a given duration in seconds.

Parameters

dest	Final color to fade to
duration	Duration to fade over, in seconds

Property Documentation

Vector Chunks.Interface.CameraRig.DefaultOrigin

getset

Default local position to center the camera rig transform over when it is reset.

float Chunks.Interface.CameraRig.DefaultScale

getset

Default local scale to reset the camera rig transform to.

float Chunks.Interface.CameraRig.FarClipPlane

getset

Far clip plane distance of the camera.

Entities.Transform Chunks.Interface.CameraRig.HeadTransform

getset

Transformation of the head mounted display.

MenuDock Chunks.Interface.CameraRig.MenuDock

get

float Chunks.Interface.CameraRig.NearClipPlane

getset

Near clip plane distance of the camera.

Color Chunks.Interface.CameraRig.ScreenOverlayColor

getset

Overlay tint color, used for fading in and out.

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

Source/Chunks/Interface/CameraRig.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation