Inherits View.

Public Member Functions
virtual void	init (void)

virtual UnsignedInt	getID (void)

virtual Drawable *	pickDrawable (const ICoord2D *screen, Bool forceAttack, PickType pickType)
	pick drawable given the screen pixel coords. If force attack, picks bridges as well.

virtual Int	iterateDrawablesInRegion (IRegion2D screenRegion, Bool(callback)(Drawable draw, void userData), void *userData)
	pick drawable given the screen pixel coords

virtual WorldToScreenReturn	worldToScreenTriReturn (const Coord3D w, ICoord2D s)
	Like worldToScreen(), but with a more informative return value.

virtual void	screenToWorld (const ICoord2D s, Coord3D w)
	Transform world coordinate "w" into screen coordinate "s".

virtual void	screenToTerrain (const ICoord2D screen, Coord3D world)
	Transform screen coordinate "s" into world coordinate "w".

virtual void	screenToWorldAtZ (const ICoord2D s, Coord3D w, Real z)
	transform screen coord to a point on the 3D terrain

virtual void	getScreenCornerWorldPointsAtZ (Coord3D topLeft, Coord3D topRight, Coord3D bottomLeft, Coord3D bottomRight, Real z)
	transform screen point to world point at the specified world Z value

virtual void	drawView (void)
	Render the world visible in this view.

virtual void	updateView (void)
	Render the world visible in this view.

virtual void	setZoomLimited (Bool limit)
	Render the world visible in this view.

virtual Bool	isZoomLimited (void)
	get status of zoom limit

virtual void	setWidth (Int width)

virtual Int	getWidth (void)

virtual void	setHeight (Int height)

virtual Int	getHeight (void)

virtual void	setOrigin (Int x, Int y)
	Sets location of top-left view corner on display.

virtual void	getOrigin (Int x, Int y)
	Return location of top-left view corner on display.

virtual void	forceRedraw ()

virtual void	lookAt (const Coord3D *o)
	Center the view on the given coordinate.

virtual void	initHeightForMap (void)
	Center the view on the given coordinate.

virtual void	scrollBy (Coord2D *delta)
	Init the camera height for the map at the current position.

virtual void	moveCameraTo (const Coord3D *o, Int frames, Int shutter, Bool orient, Real easeIn, Real easeOut)
	Shift the view by the given delta.

virtual void	moveCameraAlongWaypointPath (Waypoint *way, Int frames, Int shutter, Bool orient, Real easeIn, Real easeOut)

virtual Bool	isCameraMovementFinished (void)

virtual void	resetCamera (const Coord3D *location, Int frames, Real easeIn, Real easeOut)

virtual void	rotateCamera (Real rotations, Int frames, Real easeIn, Real easeOut)
	Move camera to location, and reset to default angle & zoom.

virtual void	rotateCameraTowardObject (ObjectID id, Int milliseconds, Int holdMilliseconds, Real easeIn, Real easeOut)
	Rotate camera about current viewpoint.

virtual void	cameraModFinalZoom (Real finalZoom, Real easeIn, Real easeOut)
	Rotate camera to face an object, and hold on it.

virtual void	cameraModRollingAverage (Int framesToAverage)
	Final zoom for current camera movement.

virtual void	cameraModFinalTimeMultiplier (Int finalMultiplier)
	Number of frames to average movement for current camera movement.

virtual void	cameraModFinalPitch (Real finalPitch, Real easeIn, Real easeOut)
	Final time multiplier for current camera movement.

virtual void	cameraModFreezeTime (void)
	Final pitch for current camera movement.

virtual void	cameraModFreezeAngle (void)
	Freezes time during the next camera movement.

virtual void	cameraModLookToward (Coord3D *pLoc)
	Sets a look at point during camera movement.

virtual void	cameraModFinalLookToward (Coord3D *pLoc)
	Sets a look at point during camera movement.

virtual void	cameraModFinalMoveTo (Coord3D *pLoc)

virtual Bool	isTimeFrozen (void)
	Sets a final move to.

virtual Int	getTimeMultiplier (void)

virtual void	setTimeMultiplier (Int multiple)
	Get the time multiplier.

virtual void	setDefaultView (Real pitch, Real angle, Real maxHeight)
	Set the time multiplier.

virtual void	zoomCamera (Real finalZoom, Int milliseconds, Real easeIn, Real easeOut)

virtual void	pitchCamera (Real finalPitch, Int milliseconds, Real easeIn, Real easeOut)

virtual void	setAngle (Real angle)
	Rotate the view around the up axis to the given angle.

virtual Real	getAngle (void)
	Rotate the view around the up axis to the given angle.

virtual void	setPitch (Real angle)
	Rotate the view around the horizontal axis to the given angle.

virtual Real	getPitch (void)
	Rotate the view around the horizontal axis to the given angle.

virtual void	setAngleAndPitchToDefault (void)
	Set the view angle back to default.

virtual void	getPosition (Coord3D *pos)
	Set the view angle back to default.

virtual Real	getHeightAboveGround ()

virtual void	setHeightAboveGround (Real z)

virtual Real	getZoom ()

virtual void	setZoom (Real z)

virtual void	zoomIn (void)
	Zoom in, closer to the ground, limit to min.

virtual void	zoomOut (void)
	Zoom out, farther away from the ground, limit to max.

virtual void	setZoomToDefault (void)
	Set zoom to default value.

virtual Real	getMaxZoom (void)
	return max zoom value

virtual void	setOkToAdjustHeight (Bool val)
	Set this to adjust camera height.

virtual Real	getTerrainHeightUnderCamera ()

virtual void	setTerrainHeightUnderCamera (Real z)

virtual Real	getCurrentHeightAboveGround ()

virtual void	setCurrentHeightAboveGround (Real z)

virtual void	getLocation (ViewLocation *location)
	write the view's current location in to the view location object

virtual void	setLocation (const ViewLocation *location)
	write the view's current location in to the view location object

virtual ObjectID	getCameraLock () const
	set the view's current location from to the view location object

virtual void	setCameraLock (ObjectID id)

virtual void	snapToCameraLock (void)

virtual void	setSnapMode (CameraLockType lockType, Real lockDist)

virtual Drawable *	getCameraLockDrawable () const

virtual void	setCameraLockDrawable (Drawable *drawable)

virtual void	setMouseLock (Bool mouseLocked)
	lock/unlock the mouse input to the tactical view

virtual Bool	isMouseLocked (void)
	is the mouse input locked to the tactical view?

virtual void	setFieldOfView (Real angle)
	Set the horizontal field of view angle.

virtual Real	getFieldOfView (void)
	Set the horizontal field of view angle.

virtual Bool	setViewFilterMode (enum FilterModes)
	Get the horizontal field of view angle.

virtual void	setViewFilterPos (const Coord3D *pos)

virtual void	setFadeParameters (Int fadeFrames, Int direction)
	stub

virtual void	set3DWireFrameMode (Bool enable)
	stub

virtual Bool	setViewFilter (enum FilterTypes m_viewFilterMode)
	stub

virtual enum FilterModes	getViewFilterMode (void)
	Turns on viewport special effect (black & white mode)

virtual enum FilterTypes	getViewFilterType (void)
	Turns on viewport special effect (black & white mode)

virtual void	shake (const Coord3D *epicenter, CameraShakeType shakeType)
	Add an impulse force to shake the camera.

virtual Real	getFXPitch (void) const
	returns the FX pitch angle

virtual void	forceCameraConstraintRecalc (void)

virtual void	rotateCameraTowardPosition (const Coord3D *pLoc, Int milliseconds, Real easeIn, Real easeOut, Bool reverseRotation)
	Rotate camera to face an object, and hold on it.

virtual const Coord3D &	get3DCameraPosition () const
	Rotate camera to face an object, and hold on it.

virtual void	setGuardBandBias (const Coord2D *gb)

Public Member Functions inherited from View
	View (void)

virtual	~View (void)

virtual void	reset (void)

virtual void	cameraEnableSlaveMode (const AsciiString &thingtemplateName, const AsciiString &boneName)
	Sets a final move to.

virtual void	cameraDisableSlaveMode (void)

virtual void	Add_Camera_Shake (const Coord3D &position, float radius, float duration, float power)

Bool	worldToScreen (const Coord3D w, ICoord2D s)
	Transform world coordinate "w" into screen coordinate "s".

Public Member Functions inherited from Snapshot
	Snapshot (void)

	~Snapshot (void)

Protected Member Functions
virtual View *	prependViewToList (View *list)
	Prepend this view to the given list, return the new list.

virtual View *	getNextView (void)
	Prepend this view to the given list, return the new list.

Protected Member Functions inherited from View
virtual void	crc (Xfer *xfer)
	run the "light" crc check on this data structure

virtual void	xfer (Xfer *xfer)

virtual void	loadPostProcess (void)

void	setPosition (const Coord3D *pos)

const Coord3D *	getPosition (void) const

Protected Attributes
Int	m_width

Int	m_height
	Dimensions of the view.

Int	m_originX

Int	m_originY
	Location of top/left view corner.

Protected Attributes inherited from View
View *	m_next
	List links used by the Display class.

UnsignedInt	m_id
	Rhe ID of this view.

Coord3D	m_pos
	Position of this view, in world coordinates.

Int	m_width

Int	m_height
	Dimensions of the view.

Int	m_originX

Int	m_originY
	Location of top/left view corner.

Real	m_angle
	Angle at which view has been rotated about the Z axis.

Real	m_pitchAngle
	Rotation of view direction around horizontal (X) axis.

Real	m_maxZoom
	Largest zoom value (minimum actual zoom)

Real	m_minZoom
	Smallest zoom value (maximum actual zoom)

Real	m_maxHeightAboveGround

Real	m_minHeightAboveGround

Real	m_zoom
	Current zoom value.

Real	m_heightAboveGround
	User's desired height above ground.

Bool	m_zoomLimited
	Camera restricted in zoom height.

Real	m_defaultAngle

Real	m_defaultPitchAngle

Real	m_currentHeightAboveGround
	Cached value for debugging.

Real	m_terrainHeightUnderCamera
	Cached value for debugging.

ObjectID	m_cameraLock
	if nonzero, id of object that the camera should follow

Drawable *	m_cameraLockDrawable
	if nonzero, drawble of object that camera should follow.

CameraLockType	m_lockType
	are we following or just tethering?

Real	m_lockDist
	how far can we be when tethered?

Real	m_FOV
	the current field of view angle

Bool	m_mouseLocked
	is the mouse input locked to the tactical view?

Bool	m_okToAdjustHeight
	Should we attempt to adjust camera height?

Bool	m_snapImmediate
	Should we immediately snap to the object we're following?

Coord2D	m_guardBandBias
	Exttra beefy margins so huge thins can stay "on-screen".

Additional Inherited Members
Public Types inherited from View
enum	CameraShakeType { SHAKE_SUBTLE = 0 , SHAKE_NORMAL , SHAKE_STRONG , SHAKE_SEVERE , SHAKE_CINE_EXTREME , SHAKE_CINE_INSANE , SHAKE_COUNT }
	Add an impulse force to shake the camera. More...

enum	WorldToScreenReturn { WTS_INSIDE_FRUSTUM = 0 , WTS_OUTSIDE_FRUSTUM , WTS_INVALID , WTS_COUNT }

enum	CameraLockType { LOCK_FOLLOW , LOCK_TETHER }

Static Protected Attributes inherited from View
static UnsignedInt	m_idNext = 1
	Used for allocating view ID's for all views.

Detailed Description

Definition at line 160 of file wbview3d.cpp.

Member Function Documentation

◆ cameraModFinalLookToward()

virtual void PlaceholderView::cameraModFinalLookToward ( Coord3D * pLoc )

inlinevirtual

Sets a look at point during camera movement.

Reimplemented from View.

Definition at line 222 of file wbview3d.cpp.

◆ cameraModFinalMoveTo()

virtual void PlaceholderView::cameraModFinalMoveTo ( Coord3D * pLoc )

inlinevirtual

Reimplemented from View.

Definition at line 223 of file wbview3d.cpp.

◆ cameraModFinalPitch()

virtual void PlaceholderView::cameraModFinalPitch	(	Real	finalPitch,
		Real	easeIn,
		Real	easeOut )

inlinevirtual

Final time multiplier for current camera movement.

Reimplemented from View.

Definition at line 218 of file wbview3d.cpp.

◆ cameraModFinalTimeMultiplier()

virtual void PlaceholderView::cameraModFinalTimeMultiplier ( Int finalMultiplier )

inlinevirtual

Number of frames to average movement for current camera movement.

Reimplemented from View.

Definition at line 217 of file wbview3d.cpp.

◆ cameraModFinalZoom()

virtual void PlaceholderView::cameraModFinalZoom	(	Real	finalZoom,
		Real	easeIn,
		Real	easeOut )

inlinevirtual

Rotate camera to face an object, and hold on it.

Reimplemented from View.

Definition at line 215 of file wbview3d.cpp.

◆ cameraModFreezeAngle()

virtual void PlaceholderView::cameraModFreezeAngle ( void )

inlinevirtual

Freezes time during the next camera movement.

Reimplemented from View.

Definition at line 220 of file wbview3d.cpp.

◆ cameraModFreezeTime()

virtual void PlaceholderView::cameraModFreezeTime ( void )

inlinevirtual

Final pitch for current camera movement.

Freezes time during the next camera movement.

Reimplemented from View.

Definition at line 219 of file wbview3d.cpp.

◆ cameraModLookToward()

virtual void PlaceholderView::cameraModLookToward ( Coord3D * pLoc )

inlinevirtual

Sets a look at point during camera movement.

Reimplemented from View.

Definition at line 221 of file wbview3d.cpp.

◆ cameraModRollingAverage()

virtual void PlaceholderView::cameraModRollingAverage ( Int framesToAverage )

inlinevirtual

Final zoom for current camera movement.

Reimplemented from View.

Definition at line 216 of file wbview3d.cpp.

◆ drawView()

virtual void PlaceholderView::drawView ( void )

inlinevirtual

Render the world visible in this view.

Implements View.

Definition at line 189 of file wbview3d.cpp.

◆ forceCameraConstraintRecalc()

virtual void PlaceholderView::forceCameraConstraintRecalc ( void )

inlinevirtual

Reimplemented from View.

Definition at line 281 of file wbview3d.cpp.

◆ forceRedraw()

virtual void PlaceholderView::forceRedraw ( )

inlinevirtual

Implements View.

Definition at line 202 of file wbview3d.cpp.

◆ get3DCameraPosition()

virtual const Coord3D & PlaceholderView::get3DCameraPosition ( ) const

inlinevirtual

Rotate camera to face an object, and hold on it.

Returns the actual camera position

Implements View.

Definition at line 284 of file wbview3d.cpp.

◆ getAngle()

virtual Real PlaceholderView::getAngle ( void )

inlinevirtual

Rotate the view around the up axis to the given angle.

Reimplemented from View.

Definition at line 232 of file wbview3d.cpp.

◆ getCameraLock()

virtual ObjectID PlaceholderView::getCameraLock ( ) const

inlinevirtual

set the view's current location from to the view location object

Reimplemented from View.

Definition at line 256 of file wbview3d.cpp.

◆ getCameraLockDrawable()

virtual Drawable * PlaceholderView::getCameraLockDrawable ( ) const

inlinevirtual

Reimplemented from View.

Definition at line 261 of file wbview3d.cpp.

◆ getCurrentHeightAboveGround()

virtual Real PlaceholderView::getCurrentHeightAboveGround ( )

inlinevirtual

Reimplemented from View.

Definition at line 250 of file wbview3d.cpp.

◆ getFieldOfView()

virtual Real PlaceholderView::getFieldOfView ( void )

inlinevirtual

Set the horizontal field of view angle.

Reimplemented from View.

Definition at line 268 of file wbview3d.cpp.

◆ getFXPitch()

virtual Real PlaceholderView::getFXPitch ( void ) const

inlinevirtual

returns the FX pitch angle

Reimplemented from View.

Definition at line 280 of file wbview3d.cpp.

◆ getHeight()

virtual Int PlaceholderView::getHeight ( void )

inlinevirtual

Reimplemented from View.

Definition at line 198 of file wbview3d.cpp.

◆ getHeightAboveGround()

virtual Real PlaceholderView::getHeightAboveGround ( )

inlinevirtual

Reimplemented from View.

Definition at line 238 of file wbview3d.cpp.

◆ getID()

virtual UnsignedInt PlaceholderView::getID ( void )

inlinevirtual

Reimplemented from View.

Definition at line 173 of file wbview3d.cpp.

◆ getLocation()

virtual void PlaceholderView::getLocation ( ViewLocation * location )

inlinevirtual

write the view's current location in to the view location object

Reimplemented from View.

Definition at line 253 of file wbview3d.cpp.

◆ getMaxZoom()

virtual Real PlaceholderView::getMaxZoom ( void )

inlinevirtual

return max zoom value

Reimplemented from View.

Definition at line 245 of file wbview3d.cpp.

◆ getNextView()

virtual View * PlaceholderView::getNextView ( void )

inlineprotectedvirtual

Prepend this view to the given list, return the new list.

Return next view in the set

Reimplemented from View.

Definition at line 168 of file wbview3d.cpp.

◆ getOrigin()

virtual void PlaceholderView::getOrigin	(	Int *	x,
		Int *	y )

inlinevirtual

Return location of top-left view corner on display.

Reimplemented from View.

Definition at line 200 of file wbview3d.cpp.

◆ getPitch()

virtual Real PlaceholderView::getPitch ( void )

inlinevirtual

Rotate the view around the horizontal axis to the given angle.

Return current camera pitch

Reimplemented from View.

Definition at line 234 of file wbview3d.cpp.

◆ getPosition()

virtual void PlaceholderView::getPosition ( Coord3D * pos )

inlinevirtual

Set the view angle back to default.

Return camera position

Reimplemented from View.

Definition at line 236 of file wbview3d.cpp.

◆ getScreenCornerWorldPointsAtZ()

virtual void PlaceholderView::getScreenCornerWorldPointsAtZ	(	Coord3D *	topLeft,
		Coord3D *	topRight,
		Coord3D *	bottomLeft,
		Coord3D *	bottomRight,
		Real	z )

inlinevirtual

transform screen point to world point at the specified world Z value

Reimplemented from View.

Definition at line 185 of file wbview3d.cpp.

◆ getTerrainHeightUnderCamera()

virtual Real PlaceholderView::getTerrainHeightUnderCamera ( )

inlinevirtual

Reimplemented from View.

Definition at line 248 of file wbview3d.cpp.

◆ getTimeMultiplier()

virtual Int PlaceholderView::getTimeMultiplier ( void )

inlinevirtual

Reimplemented from View.

Definition at line 225 of file wbview3d.cpp.

◆ getViewFilterMode()

virtual enum FilterModes PlaceholderView::getViewFilterMode ( void )

inlinevirtual

Turns on viewport special effect (black & white mode)

Reimplemented from View.

Definition at line 275 of file wbview3d.cpp.

◆ getViewFilterType()

virtual enum FilterTypes PlaceholderView::getViewFilterType ( void )

inlinevirtual

Turns on viewport special effect (black & white mode)

Reimplemented from View.

Definition at line 276 of file wbview3d.cpp.

◆ getWidth()

virtual Int PlaceholderView::getWidth ( void )

inlinevirtual

Reimplemented from View.

Definition at line 196 of file wbview3d.cpp.

◆ getZoom()

virtual Real PlaceholderView::getZoom ( )

inlinevirtual

Reimplemented from View.

Definition at line 240 of file wbview3d.cpp.

◆ init()

virtual void PlaceholderView::init ( void )

inlinevirtual

Reimplemented from View.

Definition at line 171 of file wbview3d.cpp.

◆ initHeightForMap()

virtual void PlaceholderView::initHeightForMap ( void )

inlinevirtual

Center the view on the given coordinate.

Reimplemented from View.

Definition at line 205 of file wbview3d.cpp.

◆ isCameraMovementFinished()

virtual Bool PlaceholderView::isCameraMovementFinished ( void )

inlinevirtual

Reimplemented from View.

Definition at line 211 of file wbview3d.cpp.

◆ isMouseLocked()

virtual Bool PlaceholderView::isMouseLocked ( void )

inlinevirtual

is the mouse input locked to the tactical view?

Reimplemented from View.

Definition at line 265 of file wbview3d.cpp.

◆ isTimeFrozen()

virtual Bool PlaceholderView::isTimeFrozen ( void )

inlinevirtual

Sets a final move to.

Freezes time during the next camera movement.

Reimplemented from View.

Definition at line 224 of file wbview3d.cpp.

◆ isZoomLimited()

virtual Bool PlaceholderView::isZoomLimited ( void )

inlinevirtual

get status of zoom limit

Reimplemented from View.

Definition at line 193 of file wbview3d.cpp.

◆ iterateDrawablesInRegion()

virtual Int PlaceholderView::iterateDrawablesInRegion	(	IRegion2D *	screenRegion,
		Bool(*	callback )(Drawable draw, void userData),
		void *	userData )

inlinevirtual

pick drawable given the screen pixel coords

all drawables in the 2D screen region will call the 'callback'

Implements View.

Definition at line 178 of file wbview3d.cpp.

◆ lookAt()

virtual void PlaceholderView::lookAt ( const Coord3D * o )

inlinevirtual

Center the view on the given coordinate.

Todo: this needs to be changed to be 3D, this is still old 2D stuff

Reimplemented from View.

Definition at line 204 of file wbview3d.cpp.

◆ moveCameraAlongWaypointPath()

virtual void PlaceholderView::moveCameraAlongWaypointPath	(	Waypoint *	way,
		Int	frames,
		Int	shutter,
		Bool	orient,
		Real	easeIn,
		Real	easeOut )

inlinevirtual

Reimplemented from View.

Definition at line 209 of file wbview3d.cpp.

◆ moveCameraTo()

virtual void PlaceholderView::moveCameraTo	(	const Coord3D *	o,
		Int	frames,
		Int	shutter,
		Bool	orient,
		Real	easeIn,
		Real	easeOut )

inlinevirtual

Shift the view by the given delta.

Reimplemented from View.

Definition at line 207 of file wbview3d.cpp.

◆ pickDrawable()

virtual Drawable * PlaceholderView::pickDrawable	(	const ICoord2D *	screen,
		Bool	forceAttack,
		PickType	pickType )

inlinevirtual

pick drawable given the screen pixel coords. If force attack, picks bridges as well.

Implements View.

Definition at line 175 of file wbview3d.cpp.

◆ pitchCamera()

virtual void PlaceholderView::pitchCamera	(	Real	finalPitch,
		Int	milliseconds,
		Real	easeIn,
		Real	easeOut )

inlinevirtual

Reimplemented from View.

Definition at line 229 of file wbview3d.cpp.

◆ prependViewToList()

virtual View * PlaceholderView::prependViewToList ( View * list )

inlineprotectedvirtual

Prepend this view to the given list, return the new list.

Reimplemented from View.

Definition at line 167 of file wbview3d.cpp.

◆ resetCamera()

virtual void PlaceholderView::resetCamera	(	const Coord3D *	location,
		Int	frames,
		Real	easeIn,
		Real	easeOut )

inlinevirtual

Reimplemented from View.

Definition at line 212 of file wbview3d.cpp.

◆ rotateCamera()

virtual void PlaceholderView::rotateCamera	(	Real	rotations,
		Int	frames,
		Real	easeIn,
		Real	easeOut )

inlinevirtual

Move camera to location, and reset to default angle & zoom.

Reimplemented from View.

Definition at line 213 of file wbview3d.cpp.

◆ rotateCameraTowardObject()

virtual void PlaceholderView::rotateCameraTowardObject	(	ObjectID	id,
		Int	milliseconds,
		Int	holdMilliseconds,
		Real	easeIn,
		Real	easeOut )

inlinevirtual

Rotate camera about current viewpoint.

Reimplemented from View.

Definition at line 214 of file wbview3d.cpp.

◆ rotateCameraTowardPosition()

virtual void PlaceholderView::rotateCameraTowardPosition	(	const Coord3D *	pLoc,
		Int	milliseconds,
		Real	easeIn,
		Real	easeOut,
		Bool	reverseRotation )

inlinevirtual

Rotate camera to face an object, and hold on it.

Reimplemented from View.

Definition at line 282 of file wbview3d.cpp.

◆ screenToTerrain()

virtual void PlaceholderView::screenToTerrain	(	const ICoord2D *	screen,
		Coord3D *	world )

inlinevirtual

Transform screen coordinate "s" into world coordinate "w".

Implements View.

Definition at line 183 of file wbview3d.cpp.

◆ screenToWorld()

virtual void PlaceholderView::screenToWorld	(	const ICoord2D *	s,
		Coord3D *	w )

inlinevirtual

Transform world coordinate "w" into screen coordinate "s".

Implements View.

Definition at line 182 of file wbview3d.cpp.

◆ screenToWorldAtZ()

virtual void PlaceholderView::screenToWorldAtZ	(	const ICoord2D *	s,
		Coord3D *	w,
		Real	z )

inlinevirtual

transform screen coord to a point on the 3D terrain

Implements View.

Definition at line 184 of file wbview3d.cpp.

◆ scrollBy()

virtual void PlaceholderView::scrollBy ( Coord2D * delta )

inlinevirtual

Init the camera height for the map at the current position.

Reimplemented from View.

Definition at line 206 of file wbview3d.cpp.

◆ set3DWireFrameMode()

virtual void PlaceholderView::set3DWireFrameMode ( Bool enable )

inlinevirtual

stub

Reimplemented from View.

Definition at line 273 of file wbview3d.cpp.

◆ setAngle()

virtual void PlaceholderView::setAngle ( Real angle )

inlinevirtual

Rotate the view around the up axis to the given angle.

Rotate the view around the up axis by the given angle.

Reimplemented from View.

Definition at line 231 of file wbview3d.cpp.

◆ setAngleAndPitchToDefault()

virtual void PlaceholderView::setAngleAndPitchToDefault ( void )

inlinevirtual

Set the view angle back to default.

Set the view angle back to default

Reimplemented from View.

Definition at line 235 of file wbview3d.cpp.

◆ setCameraLock()

virtual void PlaceholderView::setCameraLock ( ObjectID id )

inlinevirtual

Reimplemented from View.

Definition at line 257 of file wbview3d.cpp.

◆ setCameraLockDrawable()

virtual void PlaceholderView::setCameraLockDrawable ( Drawable * drawable )

inlinevirtual

Reimplemented from View.

Definition at line 262 of file wbview3d.cpp.

◆ setCurrentHeightAboveGround()

virtual void PlaceholderView::setCurrentHeightAboveGround ( Real z )

inlinevirtual

Reimplemented from View.

Definition at line 251 of file wbview3d.cpp.

◆ setDefaultView()

virtual void PlaceholderView::setDefaultView	(	Real	pitch,
		Real	angle,
		Real	maxHeight )

inlinevirtual

Set the time multiplier.

Reimplemented from View.

Definition at line 227 of file wbview3d.cpp.

◆ setFadeParameters()

virtual void PlaceholderView::setFadeParameters	(	Int	fadeFrames,
		Int	direction )

inlinevirtual

stub

Reimplemented from View.

Definition at line 272 of file wbview3d.cpp.

◆ setFieldOfView()

virtual void PlaceholderView::setFieldOfView ( Real angle )

inlinevirtual

Set the horizontal field of view angle.

Reimplemented from View.

Definition at line 267 of file wbview3d.cpp.

◆ setGuardBandBias()

virtual void PlaceholderView::setGuardBandBias ( const Coord2D * gb )

inlinevirtual

Implements View.

Definition at line 286 of file wbview3d.cpp.

◆ setHeight()

virtual void PlaceholderView::setHeight ( Int height )

inlinevirtual

Reimplemented from View.

Definition at line 197 of file wbview3d.cpp.

◆ setHeightAboveGround()

virtual void PlaceholderView::setHeightAboveGround ( Real z )

inlinevirtual

Reimplemented from View.

Definition at line 239 of file wbview3d.cpp.

◆ setLocation()

virtual void PlaceholderView::setLocation ( const ViewLocation * location )

inlinevirtual

write the view's current location in to the view location object

Reimplemented from View.

Definition at line 254 of file wbview3d.cpp.

◆ setMouseLock()

virtual void PlaceholderView::setMouseLock ( Bool mouseLocked )

inlinevirtual

lock/unlock the mouse input to the tactical view

Reimplemented from View.

Definition at line 264 of file wbview3d.cpp.

◆ setOkToAdjustHeight()

virtual void PlaceholderView::setOkToAdjustHeight ( Bool val )

inlinevirtual

Set this to adjust camera height.

Reimplemented from View.

Definition at line 246 of file wbview3d.cpp.

◆ setOrigin()

virtual void PlaceholderView::setOrigin	(	Int	x,
		Int	y )

inlinevirtual

Sets location of top-left view corner on display.

Reimplemented from View.

Definition at line 199 of file wbview3d.cpp.

◆ setPitch()

virtual void PlaceholderView::setPitch ( Real angle )

inlinevirtual

Rotate the view around the horizontal axis to the given angle.

Rotate the view around the horizontal (X) axis to the given angle.

Reimplemented from View.

Definition at line 233 of file wbview3d.cpp.

◆ setSnapMode()

virtual void PlaceholderView::setSnapMode	(	CameraLockType	lockType,
		Real	lockDist )

inlinevirtual

Reimplemented from View.

Definition at line 259 of file wbview3d.cpp.

◆ setTerrainHeightUnderCamera()

virtual void PlaceholderView::setTerrainHeightUnderCamera ( Real z )

inlinevirtual

Reimplemented from View.

Definition at line 249 of file wbview3d.cpp.

◆ setTimeMultiplier()

virtual void PlaceholderView::setTimeMultiplier ( Int multiple )

inlinevirtual

Get the time multiplier.

Reimplemented from View.

Definition at line 226 of file wbview3d.cpp.

◆ setViewFilter()

virtual Bool PlaceholderView::setViewFilter ( enum FilterTypes m_viewFilterMode )

inlinevirtual

stub

Reimplemented from View.

Definition at line 274 of file wbview3d.cpp.

◆ setViewFilterMode()

virtual Bool PlaceholderView::setViewFilterMode ( enum FilterModes )

inlinevirtual

Get the horizontal field of view angle.

stub

Reimplemented from View.

Definition at line 270 of file wbview3d.cpp.

◆ setViewFilterPos()

virtual void PlaceholderView::setViewFilterPos ( const Coord3D * pos )

inlinevirtual

Reimplemented from View.

Definition at line 271 of file wbview3d.cpp.

◆ setWidth()

virtual void PlaceholderView::setWidth ( Int width )

inlinevirtual

Reimplemented from View.

Definition at line 195 of file wbview3d.cpp.

◆ setZoom()

virtual void PlaceholderView::setZoom ( Real z )

inlinevirtual

Reimplemented from View.

Definition at line 241 of file wbview3d.cpp.

◆ setZoomLimited()

virtual void PlaceholderView::setZoomLimited ( Bool limit )

inlinevirtual

Render the world visible in this view.

limit the zoom height

Reimplemented from View.

Definition at line 192 of file wbview3d.cpp.

◆ setZoomToDefault()

virtual void PlaceholderView::setZoomToDefault ( void )

inlinevirtual

Set zoom to default value.

Reimplemented from View.

Definition at line 244 of file wbview3d.cpp.

◆ shake()

virtual void PlaceholderView::shake	(	const Coord3D *	epicenter,
		CameraShakeType	shakeType )

inlinevirtual

Add an impulse force to shake the camera.

Reimplemented from View.

Definition at line 278 of file wbview3d.cpp.

◆ snapToCameraLock()

virtual void PlaceholderView::snapToCameraLock ( void )

inlinevirtual

Reimplemented from View.

Definition at line 258 of file wbview3d.cpp.

◆ updateView()

virtual void PlaceholderView::updateView ( void )

inlinevirtual

Render the world visible in this view.

Implements View.

Definition at line 190 of file wbview3d.cpp.

◆ worldToScreenTriReturn()

virtual WorldToScreenReturn PlaceholderView::worldToScreenTriReturn	(	const Coord3D *	w,
		ICoord2D *	s )

inlinevirtual

Like worldToScreen(), but with a more informative return value.

Implements View.

Definition at line 181 of file wbview3d.cpp.

◆ zoomCamera()

virtual void PlaceholderView::zoomCamera	(	Real	finalZoom,
		Int	milliseconds,
		Real	easeIn,
		Real	easeOut )

inlinevirtual

Reimplemented from View.

Definition at line 228 of file wbview3d.cpp.

◆ zoomIn()

virtual void PlaceholderView::zoomIn ( void )

inlinevirtual

Zoom in, closer to the ground, limit to min.

Reimplemented from View.

Definition at line 242 of file wbview3d.cpp.

◆ zoomOut()

virtual void PlaceholderView::zoomOut ( void )

inlinevirtual

Zoom out, farther away from the ground, limit to max.

Reimplemented from View.

Definition at line 243 of file wbview3d.cpp.

Member Data Documentation

◆ m_height

Int PlaceholderView::m_height

protected

Dimensions of the view.

Definition at line 163 of file wbview3d.cpp.

◆ m_originX

Int PlaceholderView::m_originX

protected

Definition at line 164 of file wbview3d.cpp.

◆ m_originY

Int PlaceholderView::m_originY

protected

Location of top/left view corner.

Definition at line 164 of file wbview3d.cpp.

◆ m_width

Int PlaceholderView::m_width

protected

Definition at line 163 of file wbview3d.cpp.

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

Code/Tools/WorldBuilder/src/wbview3d.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ cameraModFinalLookToward()

◆ cameraModFinalMoveTo()

◆ cameraModFinalPitch()

◆ cameraModFinalTimeMultiplier()

◆ cameraModFinalZoom()

◆ cameraModFreezeAngle()

◆ cameraModFreezeTime()

◆ cameraModLookToward()

◆ cameraModRollingAverage()

◆ drawView()

◆ forceCameraConstraintRecalc()

◆ forceRedraw()

◆ get3DCameraPosition()

◆ getAngle()

◆ getCameraLock()

◆ getCameraLockDrawable()

◆ getCurrentHeightAboveGround()

◆ getFieldOfView()

◆ getFXPitch()

◆ getHeight()

◆ getHeightAboveGround()

◆ getID()

◆ getLocation()

◆ getMaxZoom()

◆ getNextView()

◆ getOrigin()

◆ getPitch()

◆ getPosition()

◆ getScreenCornerWorldPointsAtZ()

◆ getTerrainHeightUnderCamera()

◆ getTimeMultiplier()

◆ getViewFilterMode()

◆ getViewFilterType()

◆ getWidth()

◆ getZoom()

◆ init()

◆ initHeightForMap()

◆ isCameraMovementFinished()

◆ isMouseLocked()

◆ isTimeFrozen()

◆ isZoomLimited()

◆ iterateDrawablesInRegion()

◆ lookAt()

◆ moveCameraAlongWaypointPath()

◆ moveCameraTo()

◆ pickDrawable()

◆ pitchCamera()

◆ prependViewToList()

◆ resetCamera()

◆ rotateCamera()

◆ rotateCameraTowardObject()

◆ rotateCameraTowardPosition()

◆ screenToTerrain()

◆ screenToWorld()

◆ screenToWorldAtZ()

◆ scrollBy()

◆ set3DWireFrameMode()

◆ setAngle()

◆ setAngleAndPitchToDefault()

◆ setCameraLock()

◆ setCameraLockDrawable()

◆ setCurrentHeightAboveGround()

◆ setDefaultView()

◆ setFadeParameters()

◆ setFieldOfView()

◆ setGuardBandBias()

◆ setHeight()

◆ setHeightAboveGround()

◆ setLocation()

◆ setMouseLock()

◆ setOkToAdjustHeight()

◆ setOrigin()

◆ setPitch()

◆ setSnapMode()