ncView Class Reference

About this class

This class represents 3D views, used for rendering the game.

It can also be used to render picture-in-picture views on top of other views.

Inheritance diagram for ncView:

Public Member Functions
void	ncView (void)
virtual void	SetupView (void)
	the only method we we want to call setproperty()
virtual void	RenderView (void)
	only does one thing: renderscene()
virtual void	StairSmooth (void)
	when called, will modify 'origin' to vertically smoothed when on ground
virtual void	UpdateView (void)
	called every CSQC_UpdateView for each player
nonvirtual void	AddPunchAngle (vector)
	applies an punch to our camera angle, temporarily
nonvirtual void	SetViewMode (viewmode_t)
	Sets the viewmode_t of the ncView.
nonvirtual viewmode_t	GetViewMode (void)
	Gets the viewmode_t of the ncView.
nonvirtual void	SetViewPosition (vector)
	Sets the position of the ncView on the screen.
nonvirtual void	SetViewSize (vector)
	Sets the canvas of the ncView.
nonvirtual void	SetViewTarget (ncEntity)
	Sets the view target of the ncView.
nonvirtual void	SetClientOwner (ncClient)
	Sets the client owner of the ncView.
nonvirtual void	SetDrawLocalPlayer (bool)
	Call with the argument true and you will draw the body of the view target.
nonvirtual void	SetCameraOrigin (vector)
	Sets the 3D position of the ncView.
nonvirtual void	SetCameraAngle (vector)
	Sets the 3D direction of the ncView.
nonvirtual void	SetClientAngle (vector)
	Sets the client-angle of the ncView.
nonvirtual void	SetSeatID (int)
	Sets the seat id of the ncView.
nonvirtual void	SetAFOV (float)
	Sets the absolute field of view of the ncView.
nonvirtual float	GetAFOV (void)
	Returns the absolute field of view of the ncView.
nonvirtual void	SetSensitivity (float)
	Sets the sensitivity multiplier of the ncView.
nonvirtual float	GetSensitivity (void)
	Returns the sensitivity of the ncView.
nonvirtual vector	GetHUDCanvasSize (void)
	Returns the canvas size of the heads up display.
nonvirtual vector	GetHUDCanvasPos (void)
	Returns the canvas size of a heads-up-display.
nonvirtual float	GetViewWidth (void)
	Get the absolute width of the view, in pixels.
nonvirtual float	GetViewHeight (void)
	Get the absolute height of the view, in pixels.
nonvirtual vector	GetCameraOrigin (void)
	Returns the 3D world coordinate of the ncView.
nonvirtual vector	GetCameraAngle (void)
	Returns the 3D direction of the ncView.
nonvirtual void	SetSoundScape (ncSoundScape)
nonvirtual ncSoundScape	GetSoundScape (void)

Constructor & Destructor Documentation

ncView()

void ncView::ncView

(

void

)

Member Function Documentation

AddPunchAngle()

void ncView::AddPunchAngle

(

vector

vecAdd

)

applies an punch to our camera angle, temporarily

GetAFOV()

float ncView::GetAFOV

(

void

)

Returns the absolute field of view of the ncView.

GetCameraAngle()

vector ncView::GetCameraAngle

(

void

)

Returns the 3D direction of the ncView.

GetCameraOrigin()

vector ncView::GetCameraOrigin

(

void

)

Returns the 3D world coordinate of the ncView.

GetHUDCanvasPos()

vector ncView::GetHUDCanvasPos

(

void

)

Returns the canvas size of a heads-up-display.

GetHUDCanvasSize()

vector ncView::GetHUDCanvasSize

(

void

)

Returns the canvas size of the heads up display.

GetSensitivity()

float ncView::GetSensitivity

(

void

)

Returns the sensitivity of the ncView.

GetSoundScape()

ncSoundScape ncView::GetSoundScape

(

void

)

GetViewHeight()

float ncView::GetViewHeight

(

void

)

Get the absolute height of the view, in pixels.

GetViewMode()

viewmode_t ncView::GetViewMode

(

void

)

Gets the viewmode_t of the ncView.

GetViewWidth()

float ncView::GetViewWidth

(

void

)

Get the absolute width of the view, in pixels.

RenderView()

void ncView::RenderView ( void )

virtual

only does one thing: renderscene()

Reimplemented in ncRadar.

SetAFOV()

void ncView::SetAFOV

(

float

new_fov

)

Sets the absolute field of view of the ncView.

SetCameraAngle()

void ncView::SetCameraAngle

(

vector

new_angle

)

Sets the 3D direction of the ncView.

SetCameraOrigin()

void ncView::SetCameraOrigin

(

vector

new_origin

)

Sets the 3D position of the ncView.

SetClientAngle()

void ncView::SetClientAngle

(

vector

new_angle

)

Sets the client-angle of the ncView.

SetClientOwner()

void ncView::SetClientOwner

(

ncClient

new_owner

)

Sets the client owner of the ncView.

For example, when you're spectating somebody, our View Target will be the person we're spectating; whereas the owner is the client doing the spectating.

SetDrawLocalPlayer()

void ncView::SetDrawLocalPlayer

(

bool

choice

)

Call with the argument true and you will draw the body of the view target.

SetSeatID()

void ncView::SetSeatID

(

int

new_id

)

Sets the seat id of the ncView.

SetSensitivity()

void ncView::SetSensitivity

(

float

new_fov

)

Sets the sensitivity multiplier of the ncView.

SetSoundScape()

void ncView::SetSoundScape

(

ncSoundScape

newSoundScape

)

SetupView()

void ncView::SetupView ( void )

virtual

the only method we we want to call setproperty()

Reimplemented in ncRadar.

SetViewMode()

void ncView::SetViewMode

(

viewmode_t

new_mode

)

Sets the viewmode_t of the ncView.

SetViewPosition()

void ncView::SetViewPosition

(

vector

new_pos

)

Sets the position of the ncView on the screen.

SetViewSize()

void ncView::SetViewSize

(

vector

new_size

)

Sets the canvas of the ncView.

SetViewTarget()

void ncView::SetViewTarget

(

ncEntity

new_target

)

Sets the view target of the ncView.

We'll be seeing the world through their eyes.

StairSmooth()

void ncView::StairSmooth ( void )

virtual

when called, will modify 'origin' to vertically smoothed when on ground

UpdateView()

void ncView::UpdateView ( void )

virtual

called every CSQC_UpdateView for each player

---

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

• src/client/View.h
• src/client/View.qc