NSView 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 NSView:

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

Constructor & Destructor Documentation

NSView()

void NSView::NSView

(

void

)

Member Function Documentation

AddPunchAngle()

void NSView::AddPunchAngle

(

vector

vecAdd

)

applies an punch to our camera angle, temporarily

GetAFOV()

float NSView::GetAFOV

(

void

)

Returns the absolute field of view of the NSView.

GetCameraAngle()

vector NSView::GetCameraAngle

(

void

)

Returns the 3D direction of the NSView.

GetCameraOrigin()

vector NSView::GetCameraOrigin

(

void

)

Returns the 3D world coordinate of the NSView.

GetHUDCanvasPos()

vector NSView::GetHUDCanvasPos

(

void

)

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

GetHUDCanvasSize()

vector NSView::GetHUDCanvasSize

(

void

)

Returns the canvas size of the heads up display.

GetSensitivity()

float NSView::GetSensitivity

(

void

)

Returns the sensitivity of the NSView.

GetSoundScape()

NSSoundScape NSView::GetSoundScape

(

void

)

GetViewHeight()

float NSView::GetViewHeight

(

void

)

Get the absolute height of the view, in pixels.

GetViewMode()

viewmode_t NSView::GetViewMode

(

void

)

Gets the viewmode_t of the NSView.

GetViewWidth()

float NSView::GetViewWidth

(

void

)

Get the absolute width of the view, in pixels.

RenderView()

void NSView::RenderView ( void  )

virtual

only does one thing: renderscene()

Reimplemented in NSRadar.

SetAFOV()

void NSView::SetAFOV

(

float

new_fov

)

Sets the absolute field of view of the NSView.

SetCameraAngle()

void NSView::SetCameraAngle

(

vector

new_angle

)

Sets the 3D direction of the NSView.

SetCameraOrigin()

void NSView::SetCameraOrigin

(

vector

new_origin

)

Sets the 3D position of the NSView.

SetClientAngle()

void NSView::SetClientAngle

(

vector

new_angle

)

Sets the client-angle of the NSView.

SetClientOwner()

void NSView::SetClientOwner

(

NSClient

new_owner

)

Sets the client owner of the NSView.

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 NSView::SetDrawLocalPlayer

(

bool

choice

)

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

SetSeatID()

void NSView::SetSeatID

(

int

new_id

)

Sets the seat id of the NSView.

SetSensitivity()

void NSView::SetSensitivity

(

float

new_fov

)

Sets the sensitivity multiplier of the NSView.

SetSoundScape()

void NSView::SetSoundScape

(

NSSoundScape

newSoundScape

)

SetupView()

void NSView::SetupView ( void  )

virtual

the only method we we want to call setproperty()

Reimplemented in NSRadar.

SetViewMode()

void NSView::SetViewMode

(

viewmode_t

new_mode

)

Sets the viewmode_t of the NSView.

SetViewPosition()

void NSView::SetViewPosition

(

vector

new_pos

)

Sets the position of the NSView on the screen.

SetViewSize()

void NSView::SetViewSize

(

vector

new_size

)

Sets the canvas of the NSView.

SetViewTarget()

void NSView::SetViewTarget

(

NSEntity

new_target

)

Sets the view target of the NSView.

We'll be seeing the world through their eyes.

StairSmooth()

void NSView::StairSmooth ( void  )

virtual

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

UpdateView()

void NSView::UpdateView ( void  )

virtual

called every CSQC_UpdateView for each player

---

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

• src/client/NSView.h
• src/client/NSView.qc