OdGsViewWrapper< GsViewInterface, RedirectionBase > Class Template Reference

#include <GsInterfaceWrappers.h>

Inheritance diagram for OdGsViewWrapper< GsViewInterface, RedirectionBase >:

Public Member Functions
	OdGsViewWrapper (OdGsView *pRedirectionView=NULL)
OdGsDevice *	device () const
OdGiContext *	userGiContext () const
void	setUserGiContext (OdGiContext *pUserGiContext)
double	lineweightToDcScale () const
void	setLineweightToDcScale (double scale)
void	setLineweightEnum (int numLineweights, const OdUInt8 *lineweights)
void	setViewport (const OdGePoint2d &lowerLeft, const OdGePoint2d &upperRight)
void	setViewport (const OdGsDCRect &screenRect)
void	setViewport (const OdGsDCRectDouble &screenRect)
void	getViewport (OdGePoint2d &lowerLeft, OdGePoint2d &upperRight) const
void	getViewport (OdGsDCRect &screenRect) const
void	getViewport (OdGsDCRectDouble &screenRect) const
void	setViewportClipRegion (int numContours, int const *numVertices, OdGsDCPoint const *vertices)
void	setViewportClipRegion (int numContours, int const *numVertices, OdGePoint2d const *vertices)
void	viewportClipRegion (OdIntArray &counts, OdGsDCPointArray &vertices) const
void	viewportClipRegion (OdIntArray &counts, OdGePoint2dArray &vertices) const
void	setViewport3dClipping (const OdGiClipBoundary *pBoundary, const OdGiAbstractClipBoundary *pClipInfo=NULL)
const OdGiClipBoundary *	viewport3dClipping (const OdGiAbstractClipBoundary **ppClipInfo=NULL) const
void	setViewportBorderProperties (ODCOLORREF color, int width)
void	getViewportBorderProperties (ODCOLORREF &color, int &width) const
void	setViewportBorderVisibility (bool visible)
bool	isViewportBorderVisible () const
void	setView (const OdGePoint3d &position, const OdGePoint3d &target, const OdGeVector3d &upVector, double fieldWidth, double fieldHeight, OdGsView::Projection projectionType=OdGsView::kParallel)
OdGePoint3d	position () const
OdGePoint3d	target () const
OdGeVector3d	upVector () const
double	lensLength () const
void	setLensLength (double lensLength)
bool	isPerspective () const
double	fieldWidth () const
double	fieldHeight () const
void	setEnableFrontClip (bool enable)
bool	isFrontClipped () const
void	setFrontClip (double frontClip)
double	frontClip () const
void	setEnableBackClip (bool enable)
bool	isBackClipped () const
void	setBackClip (double backClip)
double	backClip () const
OdGeMatrix3d	viewingMatrix () const
OdGeMatrix3d	projectionMatrix () const
OdGeMatrix3d	screenMatrix () const
OdGeMatrix3d	worldToDeviceMatrix () const
OdGeMatrix3d	objectToDeviceMatrix () const
void	setMode (OdGsView::RenderMode mode)
OdGsView::RenderMode	mode () const
bool	add (OdGiDrawable *pSceneGraph, OdGsModel *pModel)
bool	erase (OdGiDrawable *sceneGraph)
void	eraseAll ()
OdGsModel *	getModel (const OdGiDrawable *pDrawable) const
OdGsModelArray	getModelList () const
void	invalidate ()
void	invalidate (const OdGsDCRect &screenRect)
bool	isValid () const
void	update ()
void	beginInteractivity (double frameRateInHz)
void	endInteractivity ()
bool	isInInteractivity () const
double	interactivityFrameRate () const
void	flush ()
void	hide ()
void	show ()
bool	isVisible ()
void	freezeLayer (OdDbStub *layerID)
void	thawLayer (OdDbStub *layerID)
void	clearFrozenLayers ()
void	invalidateCachedViewportGeometry ()
void	select (const OdGsDCPoint *pts, int nPoints, OdGsSelectionReactor *pReactor, OdGsView::SelectionMode mode=OdGsView::kCrossing)
void	dolly (const OdGeVector3d &dollyVector)
void	dolly (double xDolly, double yDolly, double zDolly)
void	roll (double rollAngle)
void	orbit (double xOrbit, double yOrbit)
void	zoom (double zoomFactor)
void	pan (double xPan, double yPan)
void	zoomExtents (const OdGePoint3d &minPt, const OdGePoint3d &maxPt)
void	zoomWindow (const OdGePoint2d &lowerLeft, const OdGePoint2d &upperRight)
bool	pointInView (const OdGePoint3d &pt) const
bool	extentsInView (const OdGePoint3d &minPt, const OdGePoint3d &maxPt) const
OdGsViewPtr	cloneView (bool cloneViewParameters=true, bool cloneGeometry=false)
void	viewParameters (OdGsView *pView) const
bool	exceededBounds ()
void	enableStereo (bool enabled)
bool	isStereoEnabled () const
void	setStereoParameters (double magnitude, double parallax)
void	getStereoParameters (double &magnitude, double &parallax) const
void	initLights (OdRxIterator *pLightsIterator)
void	setLinetypeScaleMultiplier (double linetypeScaleMultiplier)
double	linetypeScaleMultiplier () const
void	setAlternateLinetypeScaleMultiplier (double linetypeAlternateScaleMultiplier)
double	linetypeAlternateScaleMultiplier () const
void	clientViewInfo (OdGsClientViewInfo &clientViewInfo) const
void	setClearColor (OdGsView::ClearColor color)
bool	pointInViewport (const OdGePoint2d &screenPoint) const
void	getNumPixelsInUnitSquare (const OdGePoint3d &point, OdGePoint2d &pixelDensity, bool bUsePerspective=true) const
void	setBackground (OdDbStub *backgroundId)
OdDbStub *	background () const
void	setVisualStyle (OdDbStub *visualStyleId)
OdDbStub *	visualStyle () const
void	setVisualStyle (const OdGiVisualStyle &visualStyle)
bool	visualStyle (OdGiVisualStyle &visualStyle) const
void	enableDefaultLighting (bool bEnable, OdGsView::DefaultLightingType lightType=OdGsView::kTwoLights)
void	getSnapShot (OdGiRasterImagePtr &pImage, const OdGsDCRect &region)
Public Member Functions inherited from OdGsDefaultRedirectionBase< OdGsView, OdGsView >
	OdGsDefaultRedirectionBase (OdGsView *pRedirectionObj=NULL)
bool	hasRedirection () const
const OdGsView *	redirection () const
OdGsView *	redirection ()
void	setRedirection (OdGsView *pRedirectionObj)
void	resetRedirection ()
Public Member Functions inherited from OdGsView
	ODRX_DECLARE_MEMBERS (OdGsView)
void	removeViewportClipRegion ()
void	removeViewport3dClipping ()
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Public Types inherited from OdGsView
enum	RenderMode {   kBoundingBox = -1, k2DOptimized = 0, kWireframe = 1, kHiddenLine = 2,   kFlatShaded = 3, kGouraudShaded = 4, kFlatShadedWithWireframe = 5, kGouraudShadedWithWireframe = 6,   kNone }
enum	Projection { kParallel = 0, kPerspective = 1 }
enum	SelectionMode {   kWindow = 0, kCrossing = 1, kFence = 2, kWPoly = 3,   kCPoly = 4, kPoint = 16 }
enum	DefaultLightingType { kOneLight = 0, kTwoLights, kBackLight }
enum	ClearColor { kTransparent, kDeviceBackground, kPaletteBackground }
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
class OdGsViewWrapper< GsViewInterface, RedirectionBase >

Base template for OdGsView class wrappers.

Corresponding C++ library: TD_Gs

<group OdGs_Classes>

Definition at line 93 of file GsInterfaceWrappers.h.

Constructor & Destructor Documentation

OdGsViewWrapper()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGsViewWrapper< GsViewInterface, RedirectionBase >::OdGsViewWrapper ( OdGsView *  pRedirectionView = NULL )

inline

Definition at line 100 of file GsInterfaceWrappers.h.

Member Function Documentation

add()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::add ( OdGiDrawable *  pSceneGraph, OdGsModel *  pModel  )

inlinevirtual

Adds the specified scene graph to this Viewport object.

Parameters

pSceneGraph	[in] Pointer to the root of the scene graph.
pModel	[in] Pointer to the Model object to which all scene graph notifications are to be directed.

Remarks

This function is intended to be used as follows:

1. Construct a scene graph of OdGiDrawable objects. Each object draws its children with OdGiGeometry::draw().
2. With this function, add the root of the scene graph and the OdGsModel that handles notifications to this Viewport object.

Implements OdGsView.

Definition at line 372 of file GsInterfaceWrappers.h.

backClip()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

double OdGsViewWrapper< GsViewInterface, RedirectionBase >::backClip ( ) const

inlinevirtual

Returns the back clip distance from the target of this Viewport object.

Implements OdGsView.

Definition at line 322 of file GsInterfaceWrappers.h.

background()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdDbStub* OdGsViewWrapper< GsViewInterface, RedirectionBase >::background ( ) const

inlinevirtual

Returns current background object ID for this view.

Implements OdGsView.

Definition at line 657 of file GsInterfaceWrappers.h.

beginInteractivity()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::beginInteractivity ( double  frameRateInHz )

inlinevirtual

Puts this Viewport object into interactive state.

Parameters

frameRateInHz

[in] Frames/second.

Remarks

A frame rate of 0.0 specifies the default frame rate.

Implements OdGsView.

Definition at line 426 of file GsInterfaceWrappers.h.

clearFrozenLayers()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::clearFrozenLayers ( )

inlinevirtual

Thaws all Layer objects in this Viewport object.

Remarks

All layers are thawed by default.

Implements OdGsView.

Definition at line 482 of file GsInterfaceWrappers.h.

clientViewInfo()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::clientViewInfo ( OdGsClientViewInfo &  clientViewInfo ) const

inlinevirtual

Returns the ClientViewInfo for this Viewport object.

Parameters

clientViewInfo

[out] Receives the ClientViewInfo.

Reimplemented from OdGsView.

Definition at line 626 of file GsInterfaceWrappers.h.

cloneView()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGsViewPtr OdGsViewWrapper< GsViewInterface, RedirectionBase >::cloneView ( bool  cloneViewParameters = true, bool  cloneGeometry = false  )

inlinevirtual

Clones this view object.

Parameters

cloneViewParameters	[in] If and only if true, view parameters will be cloned.
cloneGeometry	[in] If and only if true, geometry will be cloned.

Returns

Returns a SmartPointer to the newly created object.

Implements OdGsView.

Definition at line 556 of file GsInterfaceWrappers.h.

device()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGsDevice* OdGsViewWrapper< GsViewInterface, RedirectionBase >::device ( ) const

inlinevirtual

Returns the GsDevice object associated with this Viewport object.

Implements OdGsView.

Definition at line 106 of file GsInterfaceWrappers.h.

dolly() [1/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::dolly ( const OdGeVector3d &  dollyVector )

inlinevirtual

Translates the camera position and target by the specified Camera Coordinate dolly amount.

Parameters

dollyVector	[in] Camera Coordinate dolly vector.
xDolly	[in] Camera Coordinate X dolly amount.
yDolly	[in] Camera Coordinate Y dolly amount.
zDolly	[in] Camera Coordinate Z dolly amount.

Remarks

Camera Coordinates are relative to the view of a target from a camera.

The Y-axis is along up vector. The Z-axis is along the vector from camera postiton to the target. The X-axis is the cross product Y-axis × Z-axis

Implements OdGsView.

Definition at line 501 of file GsInterfaceWrappers.h.

dolly() [2/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::dolly ( double  xDolly, double  yDolly, double  zDolly  )

inlinevirtual

Implements OdGsView.

Definition at line 506 of file GsInterfaceWrappers.h.

enableDefaultLighting()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::enableDefaultLighting ( bool  bEnable, OdGsView::DefaultLightingType  lightType = OdGsView::kTwoLights  )

inlinevirtual

Enables default lighting for this view.

Parameters

bEnable	[in] New default lighting state.
lightType	[in] New default lighting type.

Implements OdGsView.

Definition at line 687 of file GsInterfaceWrappers.h.

enableStereo()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::enableStereo ( bool  enabled )

inlinevirtual

Controls stereo viewing for this Viewport object.

Parameters

enable

[in] Controls stereo viewing.

Implements OdGsView.

Definition at line 575 of file GsInterfaceWrappers.h.

endInteractivity()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::endInteractivity ( )

inlinevirtual

Removes this Viewport object from the interactive state.

Parameters

frameRateInHz

[in] Frames/second.

Implements OdGsView.

Definition at line 431 of file GsInterfaceWrappers.h.

erase()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::erase ( OdGiDrawable *  sceneGraph )

inlinevirtual

Removes the specified scene graph from this Viewport object.

Parameters

sceneGraph

[in] Pointer to the root of the scene graph.

Implements OdGsView.

Definition at line 378 of file GsInterfaceWrappers.h.

eraseAll()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::eraseAll ( )

inlinevirtual

Removes all scene graphs from this Viewport object.

Parameters

sceneGraph

[in] Root of scene graph.

Implements OdGsView.

Definition at line 384 of file GsInterfaceWrappers.h.

exceededBounds()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::exceededBounds ( )

inlinevirtual

Returns true if an only if any view parameters have exceeded their boundaries since the last call to this function.

Remarks

The following calls are monitored:

dolly() orbit() pan() roll() setBackClip() setFrontClip() setView() zoom()

Implements OdGsView.

Definition at line 568 of file GsInterfaceWrappers.h.

extentsInView()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::extentsInView ( const OdGePoint3d &  minPt, const OdGePoint3d &  maxPt  ) const

inlinevirtual

Returns true if and only if specified WCS box is visible completely or partially inside current view frustum.

Parameters

minPt	[in] minimal WCS box point.
maxPt	[in] maximal WCS box point.

Implements OdGsView.

Definition at line 549 of file GsInterfaceWrappers.h.

fieldHeight()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

double OdGsViewWrapper< GsViewInterface, RedirectionBase >::fieldHeight ( ) const

inlinevirtual

Returns the WCS projection plane (field) height for this Viewport object.

Implements OdGsView.

Definition at line 277 of file GsInterfaceWrappers.h.

fieldWidth()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

double OdGsViewWrapper< GsViewInterface, RedirectionBase >::fieldWidth ( ) const

inlinevirtual

Returns the WCS projection plane (field) width for this Viewport object.

Implements OdGsView.

Definition at line 271 of file GsInterfaceWrappers.h.

flush()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::flush ( )

inlinevirtual

Flushes the graphic pipeline and renders this Viewport object.

Remarks

This function should be called only during interactivty.

Implements OdGsView.

Definition at line 449 of file GsInterfaceWrappers.h.

freezeLayer()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::freezeLayer ( OdDbStub *  layerID )

inlinevirtual

Freezes the specified Layer object in this Viewport object.

Parameters

layerID

[in] Layer to freeze.

Remarks

All layers are thawed by default.

Implements OdGsView.

Definition at line 472 of file GsInterfaceWrappers.h.

frontClip()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

double OdGsViewWrapper< GsViewInterface, RedirectionBase >::frontClip ( ) const

inlinevirtual

Returns the front clip distance from the target of this Viewport object.

Implements OdGsView.

Definition at line 300 of file GsInterfaceWrappers.h.

getModel()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGsModel* OdGsViewWrapper< GsViewInterface, RedirectionBase >::getModel ( const OdGiDrawable *  pDrawable ) const

inlinevirtual

Returns OdGsModel object associated with specified OdGiDrawable object in this Viewport object.

Parameters

pDrawable

[in] Pointer onto OdGiDrawable object.

Implements OdGsView.

Definition at line 390 of file GsInterfaceWrappers.h.

getModelList()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGsModelArray OdGsViewWrapper< GsViewInterface, RedirectionBase >::getModelList ( ) const

inlinevirtual

Returns array of OdGsModel objects associated with this Viewport object.

Implements OdGsView.

Definition at line 396 of file GsInterfaceWrappers.h.

getNumPixelsInUnitSquare()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getNumPixelsInUnitSquare ( const OdGePoint3d &  point, OdGePoint2d &  pixelDensity, bool  bUsePerspective = true  ) const

inlinevirtual

Returns the display pixel density at the specified point for this Viewport object.

Parameters

point	[in] WCS center of the unit square.
pixelDensity	[out] Receives the pixel density.
bUsePerspective	[in] Enable perspective inclusion into pixel density calculation.

Remarks

Pixel density is measured in pixels per WCS unit.

This function can be used to determine if the geometry generated for an object will be smaller than the size of a pixel.

Implements OdGsView.

Definition at line 645 of file GsInterfaceWrappers.h.

getSnapShot()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getSnapShot ( OdGiRasterImagePtr &  pImage, const OdGsDCRect &  region  )

inlinevirtual

Returns image of current view buffer.

Parameters

pImage	[out] Pointer for image to return.
region	[in] Rectangle specifies region to return.

Remarks

Implementation can throw eNotImplementedYet exception if current vectorization module doesn't support snap shots.

Implements OdGsView.

Definition at line 693 of file GsInterfaceWrappers.h.

getStereoParameters()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getStereoParameters ( double &  magnitude, double &  parallax  ) const

inlinevirtual

Returns the stereo parameters for this Viewport Object.

Parameters

magnitude	[out] Receives the view separation [0.0 .. 2.0].
parallax	[out] Receives the plane of zero parallax adjustment [0.0 .. 2.0].

Remarks

magnitude controls view eye separation, and hence the stereo effect.

A magnitude of 1.0 is the default value. A magnitude of 0.0 produces no stereo effect. A magnitude of 2.0 produces a double stereo effect.

parallax adjusts the zero parallax plane.

A parallax of 1.0 is the default value. An object centered at the target will be half-in and half-out of the screen. A parallax of 0.0 moves the object into the screen. A parallax of 2.0 move the object out of the screen.

Implements OdGsView.

Definition at line 591 of file GsInterfaceWrappers.h.

getViewport() [1/3]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getViewport ( OdGePoint2d &  lowerLeft, OdGePoint2d &  upperRight  ) const

inlinevirtual

Returns the size and position of this Viewport object.

Parameters

lowerLeft	[out] Receives the lower-left corner in nomalized device coordinates [0.0 .. 1.0].
upperRight	[out] Receives the upper-right corner in nomalized device coordinates [0.0 .. 1.0].
screenRect	[out] Receives the screen rectangle in device coordinates (pixels).

Remarks

(0,0) is the lower-left corner of the owning Device object. Coordinates increase upward and to the right.

The View object may be partly or completely off screen.

Implements OdGsView.

Definition at line 157 of file GsInterfaceWrappers.h.

getViewport() [2/3]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getViewport ( OdGsDCRect &  screenRect ) const

inlinevirtual

Implements OdGsView.

Definition at line 162 of file GsInterfaceWrappers.h.

getViewport() [3/3]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getViewport ( OdGsDCRectDouble &  screenRect ) const

inlinevirtual

Reimplemented from OdGsView.

Definition at line 167 of file GsInterfaceWrappers.h.

getViewportBorderProperties()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getViewportBorderProperties ( ODCOLORREF &  color, int &  width  ) const

inlinevirtual

Returns the color and width of the border for this Viewport object.

Parameters

color	[out] Receives the border color.
width	[out] Receives the border width in pixels.

Implements OdGsView.

Definition at line 211 of file GsInterfaceWrappers.h.

hide()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::hide ( )

inlinevirtual

Hides this Viewport object.

Implements OdGsView.

Definition at line 455 of file GsInterfaceWrappers.h.

initLights()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::initLights ( OdRxIterator *  pLightsIterator )

inlinevirtual

Returns an iterator to traverse the lights attached to this Viewport object.

Parameters

pLightsIterator

[in] Pointer to the lights iterator.

Implements OdGsView.

Definition at line 597 of file GsInterfaceWrappers.h.

interactivityFrameRate()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

double OdGsViewWrapper< GsViewInterface, RedirectionBase >::interactivityFrameRate ( ) const

inlinevirtual

Returns interactivity frame rate

Implements OdGsView.

Definition at line 442 of file GsInterfaceWrappers.h.

invalidate() [1/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::invalidate ( )

inlinevirtual

Marks for refresh the specified region of this Viewport object.

Parameters

screenRect

[in] Screen rectangle in device coordinates (pixels).

Remarks

If screenRect is not specified, the entire area of this View is marked for refresh.

Implements OdGsView.

Definition at line 403 of file GsInterfaceWrappers.h.

invalidate() [2/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::invalidate ( const OdGsDCRect &  screenRect )

inlinevirtual

Implements OdGsView.

Definition at line 408 of file GsInterfaceWrappers.h.

invalidateCachedViewportGeometry()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::invalidateCachedViewportGeometry ( )

inlinevirtual

Marks for regeneration all subViewportDraw() geometry for this Viewport object.

Implements OdGsView.

Definition at line 488 of file GsInterfaceWrappers.h.

isBackClipped()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isBackClipped ( ) const

inlinevirtual

Returns true if and only if back clipping is enabled for this Viewport object.

Implements OdGsView.

Definition at line 311 of file GsInterfaceWrappers.h.

isFrontClipped()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isFrontClipped ( ) const

inlinevirtual

Returns true if and only if front clipping is enabled for this Viewport object.

Implements OdGsView.

Definition at line 289 of file GsInterfaceWrappers.h.

isInInteractivity()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isInInteractivity ( ) const

inlinevirtual

Checks is this Viewport object is in interactive state.

Implements OdGsView.

Definition at line 436 of file GsInterfaceWrappers.h.

isPerspective()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isPerspective ( ) const

inlinevirtual

Returns true if and only if the projection type for this Viewport object is kPerspective.

Implements OdGsView.

Definition at line 264 of file GsInterfaceWrappers.h.

isStereoEnabled()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isStereoEnabled ( ) const

inlinevirtual

Returns true if and only if stereo viewing is enabled for this Viewport object.

Implements OdGsView.

Definition at line 580 of file GsInterfaceWrappers.h.

isValid()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isValid ( ) const

inlinevirtual

Returns true if and only if this Viewport object is showing the correct image.

Remarks

This implies the follow: No part of GUI area is flagged for refresh. All rasterizations are complete The rendering pipeline has been flushed.

Implements OdGsView.

Definition at line 413 of file GsInterfaceWrappers.h.

isViewportBorderVisible()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isViewportBorderVisible ( ) const

inlinevirtual

Returns true if and only if the border is visible for this Viewport object.

Implements OdGsView.

Definition at line 221 of file GsInterfaceWrappers.h.

isVisible()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isVisible ( )

inlinevirtual

Returns true if and only if this Viewport object is not hidden.

Implements OdGsView.

Definition at line 465 of file GsInterfaceWrappers.h.

lensLength()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

double OdGsViewWrapper< GsViewInterface, RedirectionBase >::lensLength ( ) const

inlinevirtual

Returns the perspective lens length for this Viewport object.

Implements OdGsView.

Definition at line 253 of file GsInterfaceWrappers.h.

linetypeAlternateScaleMultiplier()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

double OdGsViewWrapper< GsViewInterface, RedirectionBase >::linetypeAlternateScaleMultiplier ( ) const

inlinevirtual

Returns current alternate linetype scale multiplier value.

Implements OdGsView.

Definition at line 619 of file GsInterfaceWrappers.h.

linetypeScaleMultiplier()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

double OdGsViewWrapper< GsViewInterface, RedirectionBase >::linetypeScaleMultiplier ( ) const

inlinevirtual

Returns current linetype scale multiplier value.

Implements OdGsView.

Definition at line 608 of file GsInterfaceWrappers.h.

lineweightToDcScale()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

double OdGsViewWrapper< GsViewInterface, RedirectionBase >::lineweightToDcScale ( ) const

inlinevirtual

Returns the scale factor for displaying Lineweights in this Viewport object.

Implements OdGsView.

Definition at line 125 of file GsInterfaceWrappers.h.

mode()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGsView::RenderMode OdGsViewWrapper< GsViewInterface, RedirectionBase >::mode ( ) const

inlinevirtual

Sets the render mode for this Viewport object.

Remarks

mode must be one of the following:

Value Description kBoundingBox -1 Bounding box. For internal use only. k2DOptimized 0 Standard display. Optimized for 2D. kWireframe 1 Standard display. Uses 3D pipeline. kHiddenLine 2 Wireframe display. Hidden lines removed. kFlatShaded 3 Faceted display. One color per face. kGouraudShaded 4 Smooth shaded display. Colors interpolated between vertices. kFlatShadedWithWireframe 5 Faceted display with wireframe overlay. kGouraudShadedWithWireframe 6 Smooth shaded display with wireframe overlay.

Implements OdGsView.

Definition at line 365 of file GsInterfaceWrappers.h.

objectToDeviceMatrix()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGeMatrix3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::objectToDeviceMatrix ( ) const

inlinevirtual

Returns the matrix that transforms coordinates from model space to screen space for this Viewport object.

See also

Coordinate Systems.

Implements OdGsView.

Definition at line 353 of file GsInterfaceWrappers.h.

orbit()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::orbit ( double  xOrbit, double  yOrbit  )

inlinevirtual

Orbits the camera about the target by the specified amounts.

Parameters

xOrbit	[in] X-axis Orbit.
yOrbit	[in] Y-axis Orbit.

Remarks

he camera moves on the surface a sphere whose center the camera target and whose radius is the distance from the camera position to its target

The camera is first rotated about an axis parallel to the X-axis and passing through the target.
The camera is next rotated about an axis parallel to the Y-axis and passing through the target

Remarks

Camera Coordinates are relative to the view of a target from a camera.

The Y-axis is along up vector. The Z-axis is along the vector from camera postiton to the target. The X-axis is the cross product Y-axis × Z-axis

All angles are expressed in radians.

Implements OdGsView.

Definition at line 516 of file GsInterfaceWrappers.h.

pan()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::pan ( double  xPan, double  yPan  )

inlinevirtual

Rotates the target about the camera the specified amounts.

Parameters

xPan	[in] X-axis pan.
yPan	[in] Y-axis pan.

Remarks

The target moves on the surface a sphere whose center the camera position and whose radius is the distance from the camera position to its target

The target is first rotated about an axis parallel to the X-axis and passing through the camera.
The target is next rotated about an axis parallel to the Y-axis and passing through the camera.

Remarks

Camera Coordinates are relative to the view of a target from a camera.

The Y-axis is along up vector. The Z-axis is along the vector from camera postiton to the target. The X-axis is the cross product Y-axis × Z-axis All angles are expressed in radians.

Implements OdGsView.

Definition at line 526 of file GsInterfaceWrappers.h.

pointInView()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::pointInView ( const OdGePoint3d &  pt ) const

inlinevirtual

Returns true if and only if specified point is visible inside current view frustum.

Parameters

pt	[in] WCS point for check.

Implements OdGsView.

Definition at line 543 of file GsInterfaceWrappers.h.

pointInViewport()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::pointInViewport ( const OdGePoint2d &  screenPoint ) const

inlinevirtual

Checks does specified point is inside viewport area.

Parameters

screenPoint

[in] Check point in device coordinate space.

Implements OdGsView.

Definition at line 638 of file GsInterfaceWrappers.h.

position()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGePoint3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::position ( ) const

inlinevirtual

Returns the WCS camera position for this Viewport object.

Implements OdGsView.

Definition at line 234 of file GsInterfaceWrappers.h.

projectionMatrix()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGeMatrix3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::projectionMatrix ( ) const

inlinevirtual

Returns the matrix that transforms view space to normalized device space for this Viewport object.

See also

Coordinate Systems.

Implements OdGsView.

Definition at line 335 of file GsInterfaceWrappers.h.

roll()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::roll ( double  rollAngle )

inlinevirtual

Rotates the camera by the specified amount about the eye vector.

Parameters

rollAngle

[in] Camera CCW roll angle.

Remarks

Positive angles rotate the camera counterclockwise about the eye vector when viewed from the camera position to the target. This corresponds to a clockwise rotation of the up vector.

Camera Coordinates are relative to the view of a target from a camera.

The Y-axis is along up-vector. The Z-axis (eye vector) is along the vector from camera postiton to the target. The X-axis is the cross product Y-axis × Z-axis.

All angles are expressed in radians.

Implements OdGsView.

Definition at line 511 of file GsInterfaceWrappers.h.

screenMatrix()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGeMatrix3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::screenMatrix ( ) const

inlinevirtual

Returns the matrix that transforms normalized device space to screen space for this Viewport object.

See also

Coordinate Systems.

Implements OdGsView.

Definition at line 341 of file GsInterfaceWrappers.h.

select()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::select ( const OdGsDCPoint *  pts, int  nPoints, OdGsSelectionReactor *  pReactor, OdGsView::SelectionMode  mode = OdGsView::kCrossing  )

inlinevirtual

Runs selection procedure inside this Viewport object.

Parameters

pts	[in] Selection points in device coordinate space.
nPoints	[in] Count of selection points.
pReactor	[in] Selection callback pointer.
mode	[in] Selection mode.

Implements OdGsView.

Definition at line 494 of file GsInterfaceWrappers.h.

setAlternateLinetypeScaleMultiplier()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setAlternateLinetypeScaleMultiplier ( double  linetypeAlternateScaleMultiplier )

inlinevirtual

Sets a multiplier that could be used as an alternate scale factor for linetypes in this Viewport object.

Parameters

linetypeAlternateScaleMultiplier

[in] Alternate linetype scale multiplier.

Implements OdGsView.

Definition at line 614 of file GsInterfaceWrappers.h.

setBackClip()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setBackClip ( double  backClip )

inlinevirtual

Sets the back clip distance from the target of this Viewport object.

Parameters

backClip

[in] Back clip distance.

Implements OdGsView.

Definition at line 317 of file GsInterfaceWrappers.h.

setBackground()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setBackground ( OdDbStub *  backgroundId )

inlinevirtual

Sets background object for this view.

Parameters

backgroundId

[in] New background object ID.

Implements OdGsView.

Definition at line 652 of file GsInterfaceWrappers.h.

setClearColor()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setClearColor ( OdGsView::ClearColor  color )

inlinevirtual

Sets the clear color for this view

Parameters

color

[in] The clear color.

Implements OdGsView.

Definition at line 632 of file GsInterfaceWrappers.h.

setEnableBackClip()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setEnableBackClip ( bool  enable )

inlinevirtual

Controls the back clipping of this Viewport object.

Parameters

enable

[in] Enable back clipping.

Implements OdGsView.

Definition at line 306 of file GsInterfaceWrappers.h.

setEnableFrontClip()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setEnableFrontClip ( bool  enable )

inlinevirtual

Controls the front clipping of this Viewport object.

Parameters

enable

[in] Enable front clipping.

Implements OdGsView.

Definition at line 284 of file GsInterfaceWrappers.h.

setFrontClip()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setFrontClip ( double  frontClip )

inlinevirtual

Sets the front clip distance from the target of this Viewport object.

Parameters

frontClip

[in] Front clip distance.

Implements OdGsView.

Definition at line 295 of file GsInterfaceWrappers.h.

setLensLength()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setLensLength ( double  lensLength )

inlinevirtual

Sets the perspective lens length for this Viewport object.

Parameters

lensLength

[in] Perspective lens length.

Implements OdGsView.

Definition at line 259 of file GsInterfaceWrappers.h.

setLinetypeScaleMultiplier()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setLinetypeScaleMultiplier ( double  linetypeScaleMultiplier )

inlinevirtual

Sets a multiplier that is used to scale all linetypes in this Viewport object.

Parameters

linetypeScaleMultiplier

[in] Linetype scale multiplier.

Implements OdGsView.

Definition at line 603 of file GsInterfaceWrappers.h.

setLineweightEnum()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setLineweightEnum ( int  numLineweights, const OdUInt8 *  lineweights  )

inlinevirtual

Sets the lineweights for this Viewport object.

Parameters

numLineweights	[in] Number of Lineweights.
lineweights	[in] Array of Lineweights.

Implements OdGsView.

Definition at line 136 of file GsInterfaceWrappers.h.

setLineweightToDcScale()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setLineweightToDcScale ( double  scale )

inlinevirtual

Sets the scale factor for displaying Lineweights in this Viewport object.

Parameters

scale

[in] Scale factor.

Implements OdGsView.

Definition at line 131 of file GsInterfaceWrappers.h.

setMode()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setMode ( OdGsView::RenderMode  mode )

inlinevirtual

Sets the render mode for this Viewport object.

Parameters

mode	[in] Render mode.

Remarks

mode must be one of the following:

Value Description kBoundingBox -1 Bounding box. For internal use only. k2DOptimized 0 Standard display. Optimized for 2D. kWireframe 1 Standard display. Uses 3D pipeline. kHiddenLine 2 Wireframe display. Hidden lines removed. kFlatShaded 3 Faceted display. One color per face. kGouraudShaded 4 Smooth shaded display. Colors interpolated between vertices. kFlatShadedWithWireframe 5 Faceted display with wireframe overlay. kGouraudShadedWithWireframe 6 Smooth shaded display with wireframe overlay.

Implements OdGsView.

Definition at line 360 of file GsInterfaceWrappers.h.

setStereoParameters()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setStereoParameters ( double  magnitude, double  parallax  )

inlinevirtual

Sets the stereo parameters for this Viewport Object.

Parameters

magnitude	[in] View separation [0.0 .. 2.0].
parallax	[in] Adjusts the plane of zero parallax [0.0 .. 2.0].

Remarks

magnitude controls view eye separation, and hence the stereo effect.

A magnitude of 1.0 is the default value. A magnitude of 0.0 produces no stereo effect. A magnitude of 2.0 produces a double stereo effect.

parallax adjusts the zero parallax plane.

A parallax of 1.0 is the default value. An object centered at the target will be half-in and half-out of the screen. A parallax of 0.0 moves the object into the screen. A parallax of 2.0 move the object out of the screen.

Implements OdGsView.

Definition at line 586 of file GsInterfaceWrappers.h.

setUserGiContext()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setUserGiContext ( OdGiContext *  pUserGiContext )

inlinevirtual

Sets the User Context object associated with this Viewport object.

Parameters

pUserGiContext

[in] Pointer to the User Context.

Implements OdGsView.

Definition at line 119 of file GsInterfaceWrappers.h.

setView()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setView ( const OdGePoint3d &  position, const OdGePoint3d &  target, const OdGeVector3d &  upVector, double  fieldWidth, double  fieldHeight, OdGsView::Projection  projectionType = OdGsView::kParallel  )

inlinevirtual

Sets the camera parameters for this Viewport object.

Parameters

position	[in] Camera position.
target	[in] Camera target.
upVector	[in] Camera up vector.
fieldWidth	[in] Projection plane (field) width.
fieldHeight	[in] Projection plane (field) height.
projectionType	[in] Projection type.

Remarks

All parameters are in WCS coordinates.

projectionType must be one of the following:

Value kParallel 0 kPerspective 1

Remarks

This method defines the transfomation from WCS coordinates to normalized device coordinates.

Implements OdGsView.

Definition at line 228 of file GsInterfaceWrappers.h.

setViewport() [1/3]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewport ( const OdGePoint2d &  lowerLeft, const OdGePoint2d &  upperRight  )

inlinevirtual

Sets the size and position of this Viewport object.

Parameters

lowerLeft	[in] Lower-left corner in nomalized device coordinates [0.0 .. 1.0].
upperRight	[in] Upper-right corner in nomalized device coordinates [0.0 .. 1.0].
screenRect	[in] Screen rectangle in device coordinates (pixels).

Remarks

(0,0) is the lower-left corner of the owning Device object. Coordinates increase upward and to the right.

The View object can be partly or completely off screen.

Implements OdGsView.

Definition at line 142 of file GsInterfaceWrappers.h.

setViewport() [2/3]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewport ( const OdGsDCRect &  screenRect )

inlinevirtual

Implements OdGsView.

Definition at line 147 of file GsInterfaceWrappers.h.

setViewport() [3/3]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewport ( const OdGsDCRectDouble &  screenRect )

inlinevirtual

Reimplemented from OdGsView.

Definition at line 152 of file GsInterfaceWrappers.h.

setViewport3dClipping()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewport3dClipping ( const OdGiClipBoundary *  pBoundary, const OdGiAbstractClipBoundary *  pClipInfo = NULL  )

inlinevirtual

Defines the 3d clipping for this Viewport object.

Parameters

pBoundary	[in] 3d clipping boundary.
pClipInfo	[in] Optional 3d clipping boundary extended data.

Reimplemented from OdGsView.

Definition at line 194 of file GsInterfaceWrappers.h.

setViewportBorderProperties()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewportBorderProperties ( ODCOLORREF  color, int  width  )

inlinevirtual

Sets the color and width of the border for this Viewport object.

Parameters

color	[in] Border color.
width	[in] Border width in pixels.

Implements OdGsView.

Definition at line 206 of file GsInterfaceWrappers.h.

setViewportBorderVisibility()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewportBorderVisibility ( bool  visible )

inlinevirtual

Controls the border visibility for this Viewport object.

Parameters

visible

[in] Controls visibility.

Implements OdGsView.

Definition at line 216 of file GsInterfaceWrappers.h.

setViewportClipRegion() [1/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewportClipRegion ( int  numContours, int const *  numVertices, OdGePoint2d const *  vertices  )

inlinevirtual

Implements OdGsView.

Definition at line 178 of file GsInterfaceWrappers.h.

setViewportClipRegion() [2/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewportClipRegion ( int  numContours, int const *  numVertices, OdGsDCPoint const *  vertices  )

inlinevirtual

Defines a polygonal clip region for this Viewport object.

Parameters

numCoutours	[in] Number of polygonal contours.
numVertices	[in] Array of the number of vertices in each polygonal contour.
vertices	[in] Array of device coordinate (pixel) vertices defining the polygonal contours.

Implements OdGsView.

Definition at line 173 of file GsInterfaceWrappers.h.

setVisualStyle() [1/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setVisualStyle ( const OdGiVisualStyle &  visualStyle )

inlinevirtual

Sets visual style for this view.

Parameters

visualStyle

[in] New visual style data.

Implements OdGsView.

Definition at line 675 of file GsInterfaceWrappers.h.

setVisualStyle() [2/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setVisualStyle ( OdDbStub *  visualStyleId )

inlinevirtual

Sets visual style object for this view.

Parameters

visualStyleId

[in] New visual style object ID.

Implements OdGsView.

Definition at line 664 of file GsInterfaceWrappers.h.

show()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::show ( )

inlinevirtual

Un-hides this Viewport object.

Implements OdGsView.

Definition at line 460 of file GsInterfaceWrappers.h.

target()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGePoint3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::target ( ) const

inlinevirtual

Returns the WCS camera target for this Viewport object.

Implements OdGsView.

Definition at line 240 of file GsInterfaceWrappers.h.

thawLayer()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::thawLayer ( OdDbStub *  layerID )

inlinevirtual

Thaws the specified Layer object in this Viewport object.

Parameters

layerID

[in] Layer to thaw.

Remarks

All layers are thawed by default.

Implements OdGsView.

Definition at line 477 of file GsInterfaceWrappers.h.

update()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::update ( )

inlinevirtual

Flushes any queued graphics to the display device.

Remarks

If called while this Viewport object is in the interactive state, this function immediately returns.

Implements OdGsView.

Definition at line 420 of file GsInterfaceWrappers.h.

upVector()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGeVector3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::upVector ( ) const

inlinevirtual

Returns the WCS camera up vector for this Viewport object.

Implements OdGsView.

Definition at line 246 of file GsInterfaceWrappers.h.

userGiContext()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGiContext* OdGsViewWrapper< GsViewInterface, RedirectionBase >::userGiContext ( ) const

inlinevirtual

Returns the GiContext object associated with this Viewport object.

Implements OdGsView.

Definition at line 113 of file GsInterfaceWrappers.h.

viewingMatrix()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGeMatrix3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::viewingMatrix ( ) const

inlinevirtual

Returns the matrix that transforms world space to view space for this Viewport object.

See also

Coordinate Systems.

Implements OdGsView.

Definition at line 329 of file GsInterfaceWrappers.h.

viewParameters()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::viewParameters ( OdGsView *  pView ) const

inlinevirtual

Sets the view parameters of the specified OdGsView object to that of this Viewport object.

Parameters

pView

[out] Receives the view parameters.

Implements OdGsView.

Definition at line 562 of file GsInterfaceWrappers.h.

viewport3dClipping()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

const OdGiClipBoundary* OdGsViewWrapper< GsViewInterface, RedirectionBase >::viewport3dClipping ( const OdGiAbstractClipBoundary **  ppClipInfo = NULL ) const

inlinevirtual

Returns the current 3d clipping for this Viewport object.

Parameters

ppClipInfo

[out] Optional 3d clipping boundary extended data.

Remarks

Returns null if 3d clipping boundary doesn't set.

Reimplemented from OdGsView.

Definition at line 199 of file GsInterfaceWrappers.h.

viewportClipRegion() [1/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::viewportClipRegion ( OdIntArray &  counts, OdGePoint2dArray &  vertices  ) const

inlinevirtual

Implements OdGsView.

Definition at line 188 of file GsInterfaceWrappers.h.

viewportClipRegion() [2/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::viewportClipRegion ( OdIntArray &  counts, OdGsDCPointArray &  vertices  ) const

inlinevirtual

Returns a polygonal clip region for this Viewport object.

Parameters

counts	[out] Array of the number of vertices in each polygonal contour.
vertices	[out] Array of device coordinate (pixel) vertices defining the polygonal contours.

Implements OdGsView.

Definition at line 183 of file GsInterfaceWrappers.h.

visualStyle() [1/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdDbStub* OdGsViewWrapper< GsViewInterface, RedirectionBase >::visualStyle ( ) const

inlinevirtual

Returns current visual style object ID for this view.

Implements OdGsView.

Definition at line 669 of file GsInterfaceWrappers.h.

visualStyle() [2/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::visualStyle ( OdGiVisualStyle &  visualStyle ) const

inlinevirtual

Returns current visual style for this view.

Parameters

visualStyle

[out] OdGiVisualStyle structure to fill by current visual style data.

Returns

Returns true if and only if OdGiVisualStyle structure is filled by visual style data.

Implements OdGsView.

Definition at line 680 of file GsInterfaceWrappers.h.

worldToDeviceMatrix()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

OdGeMatrix3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::worldToDeviceMatrix ( ) const

inlinevirtual

Returns a matrix that transforms coordinates from world space to screen space for this Viewport object.

Remarks

This is equivalent to the concatenation of the viewingMatrix, projectionMatrix, and screenMatrix.

See also

Coordinate Systems.

Implements OdGsView.

Definition at line 347 of file GsInterfaceWrappers.h.

zoom()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::zoom ( double  zoomFactor )

inlinevirtual

Scales the focal length of the camera by the specified amount.

Parameters

zoomFactor

[in] Zoom factor.

Implements OdGsView.

Definition at line 521 of file GsInterfaceWrappers.h.

zoomExtents()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::zoomExtents ( const OdGePoint3d &  minPt, const OdGePoint3d &  maxPt  )

inlinevirtual

Scales the camera to completely include specified WCS box inside view frustum.

Parameters

minPt	[in] minimal WCS box point.
maxPt	[in] maximal WCS box point.

Implements OdGsView.

Definition at line 532 of file GsInterfaceWrappers.h.

zoomWindow()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>

void OdGsViewWrapper< GsViewInterface, RedirectionBase >::zoomWindow ( const OdGePoint2d &  lowerLeft, const OdGePoint2d &  upperRight  )

inlinevirtual

Scales the camera to completely include specified screen area.

Parameters

lowerLeft	[in] Lower-left corner in nomalized device coordinates [0.0 .. 1.0].
upperRight	[in] Upper-right corner in nomalized device coordinates [0.0 .. 1.0].

Implements OdGsView.

Definition at line 537 of file GsInterfaceWrappers.h.

---

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

• GsInterfaceWrappers.h