ZVIEW Class Reference

Manage z/elevation/surface and view/canvas interaction. More...

#include <mi32/zview.h>

Public Member Functions
	ZVIEW ()
	~ZVIEW ()
void	CalcDisplacedPointDual (const DPOINT3D &ptBase, DPOINT2D &ptLeft, DPOINT2D &ptRight) const
void	CalcDisplacedPointDualOnSurface (DPOINT3D &ptBase, DPOINT2D &ptLeft, DPOINT2D &ptRight) const
void	CalcDisplacedPointLeft (const DPOINT3D &ptBase, DPOINT2D &ptDisplaced) const
void	CalcDisplacedPointRight (const DPOINT3D &ptBase, DPOINT2D &ptDisplaced) const
void	CalcDisplacedPointSingleOnSurface (DPOINT3D &ptBase, DPOINT2D &ptDisplaced) const
void	CalcDisplacedPolylineDual (const POLYLINE &plBase, POLYLINE &plLeft, POLYLINE &plRight, bool UseSurfaceZ) const
void	CalcDisplacedPolylineSingle (const POLYLINE &plBase, POLYLINE &plDisplaced, bool UseSurfaceZ) const
void	CalcDisplacedSubRegionDual (const SUBREGION2D &srBase, SUBREGION2D &srLeft, SUBREGION2D &srRight, bool UseSurfaceZ) const
void	CalcDisplacedSubRegionSingle (const SUBREGION2D &srBase, SUBREGION2D &srDisplaced, bool UseSurfaceZ) const
bool	CalcPointZ (DPOINT3D &ptDevice) const
void	CloseSurface ()
const STEREOSHIFT &	GetStereoShift () const
bool	HasStereoShift () const
bool	HasSurface () const
void	InvalidateStereoShift ()
void	SetStereoShift (const STEREOSHIFT &StereoShift)
ERRVALUE	SetupSurface (SPATMOD::IMAGE::STAGE &StageSurface, const TRANS2D_MAPGEN &TransSurfaceToDevice, const LRECT2D &DeviceRect)
ERRVALUE	SetupSurface (const RVC::OBJITEM &ObjItemSurface, const TRANS2D_MAPGEN &TransSurfaceToDevice, const LRECT2D &DeviceRect)

Detailed Description

Manage z/elevation/surface and view/canvas interaction.

Constructor & Destructor Documentation

ZVIEW::ZVIEW ( )

Constructor.

ZVIEW::~ZVIEW ( )

Destructor.

Member Function Documentation

void ZVIEW::CalcDisplacedPointDual	(	const DPOINT3D &	ptBase,
		DPOINT2D &	ptLeft,
		DPOINT2D &	ptRight
	)			const `[inline]`

Calculate dual-view displaced points from non-displaced for overhead stereo view using Z value specified.

Parameters:

	ptBase	Base point in "device" coordinates
	ptLeft	Left displaced point in device coordinates returned
	ptRight	Right displaced point in device coordinates returned

void ZVIEW::CalcDisplacedPointDualOnSurface	(	DPOINT3D &	ptBase,
		DPOINT2D &	ptLeft,
		DPOINT2D &	ptRight
	)			const

Calculate dual-view displaced points from non-displaced for overhead stereo view using Z value from surface.

Parameters:

	ptBase	Base point in "device" coordinates, Z value will be updated
	ptLeft	Left displaced point in device coordinates returned
	ptRight	Right displaced point in device coordinates returned

void ZVIEW::CalcDisplacedPointLeft	(	const DPOINT3D &	ptBase,
		DPOINT2D &	ptDisplaced
	)			const `[inline]`

Calculate left view displaced point from non-displaced for overhead stereo view using Z value specified.

Parameters:

	ptBase	Base point in "device" coordinates
	ptDisplaced	Displaced point in device coordinates returned

void ZVIEW::CalcDisplacedPointRight	(	const DPOINT3D &	ptBase,
		DPOINT2D &	ptDisplaced
	)			const `[inline]`

Calculate right view displaced point from non-displaced for overhead stereo view using Z value specified.

Parameters:

	ptBase	Base point in "device" coordinates
	ptDisplaced	Displaced point in device coordinates returned

void ZVIEW::CalcDisplacedPointSingleOnSurface	(	DPOINT3D &	ptBase,
		DPOINT2D &	ptDisplaced
	)			const

Calculate single-view displaced point from non-displaced for overhead stereo view using Z value from surface.

Should not be used if both views are displaced.

Parameters:

	ptBase	Point in "device" coordinates, Z value will be updated
	ptDisplaced	Displaced point in device coordinates returned

void ZVIEW::CalcDisplacedPolylineDual	(	const POLYLINE &	plBase,
		POLYLINE &	plLeft,
		POLYLINE &	plRight,
		bool	UseSurfaceZ
	)			const

Calculate dual-view displaced polylines from non-displaced for overhead stereo view, optionally draping on surface.

Should only be used if both views are displaced.

Parameters:

	plBase	Polyline in "device" coordinates
	plLeft	Left displaced polyline returned
	plRight	Right displaced polyline returned
	UseSurfaceZ	Use Z value from surface

void ZVIEW::CalcDisplacedPolylineSingle	(	const POLYLINE &	plBase,
		POLYLINE &	plDisplaced,
		bool	UseSurfaceZ
	)			const

Calculate single-view displaced polyline from non-displaced for overhead stereo view, optionally draping on surface.

Should not be used if both views are displaced.

Parameters:

	plBase	Polyline in "device" coordinates
	plDisplaced	Displaced polyline returned
	UseSurfaceZ	Use Z value from surface

void ZVIEW::CalcDisplacedSubRegionDual	(	const SUBREGION2D &	srBase,
		SUBREGION2D &	srLeft,
		SUBREGION2D &	srRight,
		bool	UseSurfaceZ
	)			const

Calculate dual-view displaced subregions from non-displaced for overhead stereo view, optionally draping on surface.

Should only be used if both views are displaced.

Parameters:

	srBase	Subregion in device coordinates
	srLeft	Left displaced subregion returned
	srRight	Right displaced subregion returned
	UseSurfaceZ	Use Z value from surface

void ZVIEW::CalcDisplacedSubRegionSingle	(	const SUBREGION2D &	srBase,
		SUBREGION2D &	srDisplaced,
		bool	UseSurfaceZ
	)			const

Calculate single-view displaced subregion from non-displaced for overhead stereo view, optionally draping on surface.

Should not be used if both views are displaced.

Parameters:

	srBase	Subregion in device coordinates
	srDisplaced	Displaced subregion returned
	UseSurfaceZ	Use Z value from surface

bool ZVIEW::CalcPointZ ( DPOINT3D & ptDevice ) const

Calculate Z value for single point.

Returns:: true if has Z value, false if outside defined surface.

Parameters:

ptDevice

Point in "device" coordinates, Z value will be updated

void ZVIEW::CloseSurface ( )

Close and release currently open surface objects.

const STEREOSHIFT& ZVIEW::GetStereoShift ( ) const [inline]

Get stereo shift values.

bool ZVIEW::HasStereoShift ( ) const [inline]

Determine if has setup stereo shift.

bool ZVIEW::HasSurface ( ) const [inline]

Determine if has setup terrain surface.

void ZVIEW::InvalidateStereoShift ( ) [inline]

Reset stereo displacement.

void ZVIEW::SetStereoShift ( const STEREOSHIFT & StereoShift )

Set stereo shift values.

Parameters:

StereoShift

Values to set

ERRVALUE ZVIEW::SetupSurface	(	SPATMOD::IMAGE::STAGE &	StageSurface,
		const TRANS2D_MAPGEN &	TransSurfaceToDevice,
		const LRECT2D &	DeviceRect
	)

Setup with surface object and transformation.

Does not alter stereo displacement values.

Parameters:

	StageSurface	Pipeline stage for reading surface
	TransSurfaceToDevice	Translation from surface object to device coordinates
	DeviceRect	Device rectangle

ERRVALUE ZVIEW::SetupSurface	(	const RVC::OBJITEM &	ObjItemSurface,
		const TRANS2D_MAPGEN &	TransSurfaceToDevice,
		const LRECT2D &	DeviceRect
	)

Setup with surface object and transformation.

Does not alter stereo displacement values.

Parameters:

	ObjItemSurface	Location of surface object
	TransSurfaceToDevice	Translation from surface object to device coordinates
	DeviceRect	Device rectangle

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

mi32/zview.h

ZVIEW Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation