#include <Gs.h>

Inheritance diagram for OdGsView:

Public Types
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	ViewUpdateFlags { kCameraChanged = 1 }

enum	ClearColor { kTransparent , kDeviceBackground , kPaletteBackground }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGsView)

virtual OdGsDevice *	device () const =0

virtual OdGiContext *	userGiContext () const =0

virtual void	setUserGiContext (OdGiContext *pUserGiContext)=0

virtual double	lineweightToDcScale () const =0

virtual void	setLineweightToDcScale (double scale)=0

virtual void	setLineweightEnum (int numLineweights, const OdUInt8 *lineweights)=0

virtual void	setViewport (const OdGePoint2d &lowerLeft, const OdGePoint2d &upperRight)=0

virtual void	setViewport (const OdGsDCRect &screenRect)=0

virtual void	setViewport (const OdGsDCRectDouble &screenRect)

virtual void	getViewport (OdGePoint2d &lowerLeft, OdGePoint2d &upperRight) const =0

virtual void	getViewport (OdGsDCRect &screenRect) const =0

virtual void	getViewport (OdGsDCRectDouble &screenRect) const

virtual void	setViewportClipRegion (int numContours, int const numVertices, OdGsDCPoint const vertices)=0

virtual void	setViewportClipRegion (int numContours, int const numVertices, OdGePoint2d const vertices)=0

virtual void	viewportClipRegion (OdIntArray &counts, OdGsDCPointArray &vertices) const =0

virtual void	viewportClipRegion (OdIntArray &counts, OdGePoint2dArray &vertices) const =0

void	removeViewportClipRegion ()

virtual void	setViewport3dClipping (const OdGiClipBoundary pBoundary, const OdGiAbstractClipBoundary pClipInfo=NULL)

virtual const OdGiClipBoundary *	viewport3dClipping (const OdGiAbstractClipBoundary **ppClipInfo=NULL) const

void	removeViewport3dClipping ()

virtual void	setViewportBorderProperties (ODCOLORREF color, int width)=0

virtual void	getViewportBorderProperties (ODCOLORREF &color, int &width) const =0

virtual void	setViewportBorderVisibility (bool visible)=0

virtual bool	isViewportBorderVisible () const =0

virtual void	setView (const OdGePoint3d &position, const OdGePoint3d &target, const OdGeVector3d &upVector, double fieldWidth, double fieldHeight, Projection projectionType=kParallel)=0

virtual OdGePoint3d	position () const =0

virtual OdGePoint3d	target () const =0

virtual OdGeVector3d	upVector () const =0

virtual double	lensLength () const =0

virtual void	setLensLength (double lensLength)=0

virtual bool	isPerspective () const =0

virtual double	fieldWidth () const =0

virtual double	fieldHeight () const =0

virtual void	setEnableFrontClip (bool enable)=0

virtual bool	isFrontClipped () const =0

virtual void	setFrontClip (double frontClip)=0

virtual double	frontClip () const =0

virtual void	setEnableBackClip (bool enable)=0

virtual bool	isBackClipped () const =0

virtual void	setBackClip (double backClip)=0

virtual double	backClip () const =0

virtual OdGeMatrix3d	viewingMatrix () const =0

virtual OdGeMatrix3d	projectionMatrix () const =0

virtual OdGeMatrix3d	screenMatrix () const =0

virtual OdGeMatrix3d	worldToDeviceMatrix () const =0

virtual OdGeMatrix3d	objectToDeviceMatrix () const =0

virtual void	setMode (RenderMode mode)=0

virtual RenderMode	mode () const =0

virtual bool	add (OdGiDrawable pSceneGraph, OdGsModel pModel)=0

virtual int	numRootDrawables () const =0

virtual OdDbStub *	rootDrawableIdAt (int i, OdGsModelPtr *pModelReturn=0) const =0

virtual OdGiDrawablePtr	rootDrawableAt (int i, OdGsModelPtr *pModelReturn=0) const =0

virtual bool	erase (OdGiDrawable *sceneGraph)=0

virtual void	eraseAll ()=0

virtual OdGsModel *	getModel (const OdGiDrawable *pDrawable) const =0

virtual OdGsModelArray	getModelList () const =0

virtual void	invalidate ()=0

virtual void	invalidate (const OdGsDCRect &screenRect)=0

virtual bool	isValid () const =0

virtual void	update ()=0

virtual void	beginInteractivity (double frameRateInHz)=0

virtual bool	isInInteractivity () const =0

virtual double	interactivityFrameRate () const =0

virtual void	endInteractivity ()=0

virtual void	flush ()=0

virtual void	hide ()=0

virtual void	show ()=0

virtual bool	isVisible ()=0

virtual void	freezeLayer (OdDbStub *layerID)=0

virtual void	thawLayer (OdDbStub *layerID)=0

virtual void	clearFrozenLayers ()=0

virtual void	invalidateCachedViewportGeometry ()=0

virtual void	select (const OdGsDCPoint pts, int nPoints, OdGsSelectionReactor pReactor, OdGsView::SelectionMode mode=OdGsView::kCrossing)=0

virtual void	dolly (const OdGeVector3d &dollyVector)=0

virtual void	dolly (double xDolly, double yDolly, double zDolly)=0

virtual void	roll (double rollAngle)=0

virtual void	orbit (double xOrbit, double yOrbit)=0

virtual void	zoom (double zoomFactor)=0

virtual void	pan (double xPan, double yPan)=0

virtual void	zoomExtents (const OdGePoint3d &minPt, const OdGePoint3d &maxPt)=0

virtual void	zoomWindow (const OdGePoint2d &lowerLeft, const OdGePoint2d &upperRight)=0

virtual bool	pointInView (const OdGePoint3d &pt) const =0

virtual bool	extentsInView (const OdGePoint3d &minPt, const OdGePoint3d &maxPt) const =0

virtual OdGsViewPtr	cloneView (bool cloneViewParameters=true, bool cloneGeometry=false)=0

virtual void	viewParameters (OdGsView *pView) const =0

virtual bool	exceededBounds ()=0

virtual void	enableStereo (bool enabled)=0

virtual bool	isStereoEnabled () const =0

virtual void	setStereoParameters (double magnitude, double parallax)=0

virtual void	getStereoParameters (double &magnitude, double &parallax) const =0

virtual void	initLights (OdRxIterator *pLightsIterator)=0

virtual void	setLinetypeScaleMultiplier (double linetypeScaleMultiplier)=0

virtual double	linetypeScaleMultiplier () const =0

virtual void	setAlternateLinetypeScaleMultiplier (double linetypeAlternateScaleMultiplier)=0

virtual double	linetypeAlternateScaleMultiplier () const =0

virtual void	clientViewInfo (OdGsClientViewInfo &clientViewInfo) const

virtual void	setClearColor (ClearColor color)=0

virtual bool	pointInViewport (const OdGePoint2d &screenPoint) const =0

virtual void	getNumPixelsInUnitSquare (const OdGePoint3d &point, OdGePoint2d &pixelDensity, bool bUsePerspective=true) const =0

virtual void	setBackground (OdDbStub *backgroundId)=0

virtual OdDbStub *	background () const =0

virtual void	setVisualStyle (OdDbStub *visualStyleId)=0

virtual OdDbStub *	visualStyle () const =0

virtual void	setVisualStyle (const OdGiVisualStyle &visualStyle)=0

virtual bool	visualStyle (OdGiVisualStyle &visualStyle) const =0

virtual void	enableDefaultLighting (bool bEnable, DefaultLightingType lightType=kTwoLights)=0

virtual void	getSnapShot (OdGiRasterImagePtr &pImage, const OdGsDCRect &region)=0

virtual void	collide (OdGiPathNode const const pInputList, OdUInt32 nInputListSize, OdGsCollisionDetectionReactor pReactor, OdGiPathNode const const pCollisionWithList=NULL, OdUInt32 nCollisionWithListSize=0, const OdGsCollisionDetectionContext pCtx=NULL)=0

virtual void	enableAntiAliasing (OdUInt32 nMode)=0

virtual OdUInt32	antiAliasingMode () const =0

virtual void	enableSSAO (bool bEnable)=0

virtual bool	ssaoMode () const =0

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
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Detailed Description

This class is the abstract base class for classes that implement Viewport objects in GUI display windows.

Remarks: Each Viewport objects consists of a collection of objects to be viewed, and camera parameters that define the view.

Corresponding C++ library: TD_Gs <group OdGs_Classes>

See also: <link tv_working_with_base_classes_view, Work with Visualize Graphical Views>; <link gs_OdGsView, Work with Views>

Definition at line 139 of file Gs.h.

Member Enumeration Documentation

◆ ClearColor

enum OdGsView::ClearColor

Clear color for this view.

Enumerator
kTransparent
kDeviceBackground
kPaletteBackground

Definition at line 1043 of file Gs.h.

◆ DefaultLightingType

enum OdGsView::DefaultLightingType

Default lighting modes.

Enumerator
kOneLight
kTwoLights
kBackLight

Definition at line 186 of file Gs.h.

◆ Projection

enum OdGsView::Projection

Projection types.

Enumerator
kParallel
kPerspective

Definition at line 163 of file Gs.h.

◆ RenderMode

enum OdGsView::RenderMode

Render modes for the view.

Enumerator
kBoundingBox
k2DOptimized
kWireframe
kHiddenLine
kFlatShaded
kGouraudShaded
kFlatShadedWithWireframe
kGouraudShadedWithWireframe
kNone

Definition at line 147 of file Gs.h.

◆ SelectionMode

enum OdGsView::SelectionMode

Selection modes.

Enumerator
kWindow
kCrossing
kFence
kWPoly
kCPoly
kPoint

Definition at line 172 of file Gs.h.

◆ ViewUpdateFlags

enum OdGsView::ViewUpdateFlags

View update flags.

Enumerator
kCameraChanged

Definition at line 196 of file Gs.h.

Member Function Documentation

◆ add()

virtual bool OdGsView::add	(	OdGiDrawable *	pSceneGraph,
		OdGsModel *	pModel
	)

pure virtual

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:

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

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ antiAliasingMode()

virtual OdUInt32 OdGsView::antiAliasingMode ( ) const

pure virtual

Returns anti-aliasing mode for current Viewport object.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ backClip()

virtual double OdGsView::backClip ( ) const

pure virtual

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

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ background()

virtual OdDbStub * OdGsView::background ( ) const

pure virtual

Returns current background object ID for this view.

See also: <link tv_working_with_attributes_view_backgrounds, Work with View Backgrounds>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ beginInteractivity()

virtual void OdGsView::beginInteractivity ( double frameRateInHz )

pure virtual

Puts this Viewport object into interactive state.

Parameters

frameRateInHz [in] Frames/second.

Remarks: A frame rate of 0.0 specifies the default frame rate.

See also: <link gs_views_interactivity_mode, Work with Interactivity Mode for Views>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ clearFrozenLayers()

virtual void OdGsView::clearFrozenLayers ( )

pure virtual

Thaws all Layer objects in this Viewport object.

Remarks: All layers are thawed by default.

See also: <link tv_working_with_attributes_layers, Work with Layers>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ clientViewInfo()

virtual void OdGsView::clientViewInfo ( OdGsClientViewInfo & clientViewInfo ) const

virtual

Returns the ClientViewInfo for this Viewport object.

Parameters

clientViewInfo [out] Receives the ClientViewInfo.

Reimplemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ cloneView()

virtual OdGsViewPtr OdGsView::cloneView	(	bool	cloneViewParameters = `true`,
		bool	cloneGeometry = `false`
	)

pure virtual

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ collide()

virtual void OdGsView::collide	(	OdGiPathNode const const	pInputList,
		OdUInt32	nInputListSize,
		OdGsCollisionDetectionReactor *	pReactor,
		OdGiPathNode const const	pCollisionWithList = `NULL`,
		OdUInt32	nCollisionWithListSize = `0`,
		const OdGsCollisionDetectionContext *	pCtx = `NULL`
	)

pure virtual

Runs collision detection procedure inside this Viewport object.

Parameters

pInputList	[in] Pointer to the list of objects to check
nInputListSize	[in] Size of the list of objects to check
pCollisionWithList	[in] Pointer to the list of possible colliding objects
nCollisionWithListSize	[in] Size of the list of possible colliding objects
pCtx	[in] Pointer to the OdGsCollisionDetectionContext that provide additional Collision Detection options

Remarks: If pCollisionWithList is NULL pInputList will be checked with all other drawables. If pCollisionWithList is not a NULL pInputList will be checked with pCollisionWithList only. If pInputList is NULL all drawables will be checked on collisions with each other.

See also: <link gs_collision_detection, Work with Collision Detection>

Implemented in OdGsBaseVectorizeView, OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ device()

virtual OdGsDevice * OdGsView::device ( ) const

pure virtual

Returns the GsDevice object associated with this Viewport object.

See also: <link tv_working_with_base_classes_device, Work with Visualize Graphics Devices>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ dolly() [1/2]

virtual void OdGsView::dolly ( const OdGeVector3d & dollyVector )

pure virtual

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

Parameters

dollyVector [in] Camera Coordinate dolly vector.

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 position to the target. The X-axis is the cross product Y-axis x Z-axis

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ dolly() [2/2]

virtual void OdGsView::dolly	(	double	xDolly,
		double	yDolly,
		double	zDolly
	)

pure virtual

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

Parameters

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 position to the target. The X-axis is the cross product Y-axis x Z-axis

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ enableAntiAliasing()

virtual void OdGsView::enableAntiAliasing ( OdUInt32 nMode )

pure virtual

Enables or disables anti-aliasing in current Viewport object.

Parameters

nMode [in] Anti-aliasing mode (set as 3 by default). Set as 0 to disable anti-aliasing.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ enableDefaultLighting()

virtual void OdGsView::enableDefaultLighting	(	bool	bEnable,
		DefaultLightingType	lightType = `kTwoLights`
	)

pure virtual

Enables default lighting for this view.

Parameters

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

See also: <link tv_working_with_lights, Work with Lights>

Implemented in OdGsViewImpl, and OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >.

◆ enableSSAO()

virtual void OdGsView::enableSSAO ( bool bEnable )

pure virtual

Enables or disables ambient occlusion in current Viewport object.

Parameters

bEnable [in] Ambient occlusion mode (set as true by default). Set as false to disable ambient occlusion.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ enableStereo()

virtual void OdGsView::enableStereo ( bool enabled )

pure virtual

Controls stereo viewing for this Viewport object.

Parameters

enable [in] Controls stereo viewing.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ endInteractivity()

virtual void OdGsView::endInteractivity ( )

pure virtual

Removes this Viewport object from the interactive state.

See also: <link gs_views_interactivity_mode, Work with Interactivity Mode for Views>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ erase()

virtual bool OdGsView::erase ( OdGiDrawable * sceneGraph )

pure virtual

Removes the specified scene graph from this Viewport object.

Parameters

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

Returns: true if scene graph is successfully erased, false otherwise.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ eraseAll()

virtual void OdGsView::eraseAll ( )

pure virtual

Removes all scene graphs from this Viewport object.

Parameters

sceneGraph [in] Root of scene graph.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ exceededBounds()

virtual bool OdGsView::exceededBounds ( )

pure virtual

Checks whether any view parameters have exceeded their boundaries since the last call to this function.

Returns: true if any view parameters have exceeded their boundaries since the last call to this function, false otherwise.

Remarks: The following calls are monitored:

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

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ extentsInView()

virtual bool OdGsView::extentsInView	(	const OdGePoint3d &	minPt,
		const OdGePoint3d &	maxPt
	)		const

pure virtual

Checks whether 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.

Returns: true if the specified extents box is visible in the current viewport frustum of the wrapped view, false otherwise.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ fieldHeight()

virtual double OdGsView::fieldHeight ( ) const

pure virtual

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

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ fieldWidth()

virtual double OdGsView::fieldWidth ( ) const

pure virtual

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

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ flush()

virtual void OdGsView::flush ( )

pure virtual

Flushes the graphic pipeline and renders this Viewport object.

Remarks: This function should be called only during interactivty.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ freezeLayer()

virtual void OdGsView::freezeLayer ( OdDbStub * layerID )

pure virtual

Freezes the specified Layer object in this Viewport object.

Parameters

layerID [in] Layer to freeze.

Remarks: All layers are thawed by default.

See also: <link tv_working_with_attributes_layers, Work with Layers>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ frontClip()

virtual double OdGsView::frontClip ( ) const

pure virtual

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

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ getModel()

virtual OdGsModel * OdGsView::getModel ( const OdGiDrawable * pDrawable ) const

pure virtual

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

Parameters

pDrawable [in] Pointer onto OdGiDrawable object.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ getModelList()

virtual OdGsModelArray OdGsView::getModelList ( ) const

pure virtual

Returns array of OdGsModel objects associated with this Viewport object.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ getNumPixelsInUnitSquare()

virtual void OdGsView::getNumPixelsInUnitSquare	(	const OdGePoint3d &	point,
		OdGePoint2d &	pixelDensity,
		bool	bUsePerspective = `true`
	)		const

pure virtual

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.

Implemented in OdGsViewImpl, and OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >.

◆ getSnapShot()

virtual void OdGsView::getSnapShot	(	OdGiRasterImagePtr &	pImage,
		const OdGsDCRect &	region
	)

pure virtual

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ getStereoParameters()

virtual void OdGsView::getStereoParameters	(	double &	magnitude,
		double &	parallax
	)		const

pure virtual

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ getViewport() [1/3]

virtual void OdGsView::getViewport	(	OdGePoint2d &	lowerLeft,
		OdGePoint2d &	upperRight
	)		const

pure virtual

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].

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ getViewport() [2/3]

virtual void OdGsView::getViewport ( OdGsDCRect & screenRect ) const

pure virtual

Returns the size and position of this Viewport object.

Parameters

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ getViewport() [3/3]

virtual void OdGsView::getViewport ( OdGsDCRectDouble & screenRect ) const

virtual

Returns the size and position of this Viewport object.

Parameters

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.

Reimplemented in OdGsViewImpl, and OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >.

◆ getViewportBorderProperties()

virtual void OdGsView::getViewportBorderProperties	(	ODCOLORREF &	color,
		int &	width
	)		const

pure virtual

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ hide()

virtual void OdGsView::hide ( )

pure virtual

Hides this Viewport object.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ initLights()

virtual void OdGsView::initLights ( OdRxIterator * pLightsIterator )

pure virtual

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

Parameters

pLightsIterator [in] Pointer to the lights iterator.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ interactivityFrameRate()

virtual double OdGsView::interactivityFrameRate ( ) const

pure virtual

Returns interactivity frame rate.

See also: <link gs_views_interactivity_mode, Work with Interactivity Mode for Views>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ invalidate() [1/2]

virtual void OdGsView::invalidate ( )

pure virtual

Marks the entire area of this View for refreshing.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ invalidate() [2/2]

virtual void OdGsView::invalidate ( const OdGsDCRect & screenRect )

pure virtual

Marks for refresh the specified region of this Viewport object.

Parameters

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

Implemented in OdGsViewImpl, and OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >.

◆ invalidateCachedViewportGeometry()

virtual void OdGsView::invalidateCachedViewportGeometry ( )

pure virtual

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

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ isBackClipped()

virtual bool OdGsView::isBackClipped ( ) const

pure virtual

Checks whether back clipping is enabled for the viewport object.

Returns: true if back clipping is enabled for the viewport object, false otherwise.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ isFrontClipped()

virtual bool OdGsView::isFrontClipped ( ) const

pure virtual

Checks whether front clipping is enabled for the viewport object.

Returns: true if front clipping is enabled for the viewport object, false otherwise.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ isInInteractivity()

virtual bool OdGsView::isInInteractivity ( ) const

pure virtual

Checks whether this Viewport object is in interactive state.

Returns: true if this View is in interactivity mode, false otherwise.

See also: <link gs_views_interactivity_mode, Work with Interactivity Mode for Views>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ isPerspective()

virtual bool OdGsView::isPerspective ( ) const

pure virtual

Checks whether the projection type for the viewport object is kPerspective.

Returns: true if projection type for the viewport object is kPerspective, false otherwise.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ isStereoEnabled()

virtual bool OdGsView::isStereoEnabled ( ) const

pure virtual

Checks whether stereo viewing is enabled for this Viewport object.

Returns: true if and only if stereo viewing is enabled for this Viewport object, false otherwise.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ isValid()

virtual bool OdGsView::isValid ( ) const

pure virtual

Checks whether this Viewport shows the correct image.

Returns: true if this Viewport object is showing the correct image, false otherwise.

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

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ isViewportBorderVisible()

virtual bool OdGsView::isViewportBorderVisible ( ) const

pure virtual

Checks whether viewport border is visible.

Returns: true if the border is visible for this Viewport object, false otherwise.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ isVisible()

virtual bool OdGsView::isVisible ( )

pure virtual

Checks whether the viewport object is not hidden.

Returns: true if the wrapped viewport object is visible, false otherwise.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ lensLength()

virtual double OdGsView::lensLength ( ) const

pure virtual

Returns the perspective lens length for this Viewport object.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ linetypeAlternateScaleMultiplier()

virtual double OdGsView::linetypeAlternateScaleMultiplier ( ) const

pure virtual

Returns current alternate linetype scale multiplier value.

See also: <exref target="https://docs.opendesign.com/td/db_linetype.html">Working with Linetypes</exref>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ linetypeScaleMultiplier()

virtual double OdGsView::linetypeScaleMultiplier ( ) const

pure virtual

Returns current linetype scale multiplier value.

See also: <exref target="https://docs.opendesign.com/td/db_linetype.html">Working with Linetypes</exref>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ lineweightToDcScale()

virtual double OdGsView::lineweightToDcScale ( ) const

pure virtual

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

See also: <link tv_working_with_attributes_lineweights, Work with Lineweights>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ mode()

virtual RenderMode OdGsView::mode ( ) const

pure virtual

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ numRootDrawables()

virtual int OdGsView::numRootDrawables ( ) const

pure virtual

Retrieves a quantity of root drawables for this viewport.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ objectToDeviceMatrix()

virtual OdGeMatrix3d OdGsView::objectToDeviceMatrix ( ) const

pure virtual

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

See also: Coordinate Systems.

Implemented in OdGsBaseVectorizeViewJoin< BaseVectorizerObject >, OdGsBaseVectorizeViewJoin< OdGsBaseMaterialViewPC >, OdGsBaseVectorizeViewJoin< OdGsBaseVectorizer >, OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ ODRX_DECLARE_MEMBERS()

OdGsView::ODRX_DECLARE_MEMBERS ( OdGsView )

◆ orbit()

virtual void OdGsView::orbit	(	double	xOrbit,
		double	yOrbit
	)

pure virtual

Orbits the camera about the target by the specified amounts.

Parameters

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

Remarks: the 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. 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 position to the target. The X-axis is the cross product Y-axis x Z-axis All angles are expressed in radians.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ pan()

virtual void OdGsView::pan	(	double	xPan,
		double	yPan
	)

pure virtual

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.
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 position to the target. The X-axis is the cross product Y-axis x Z-axis All angles are expressed in radians.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ pointInView()

virtual bool OdGsView::pointInView ( const OdGePoint3d & pt ) const

pure virtual

Checks whether specified point is visible inside current view frustum.

Parameters

pt	[in] WCS point for check.

Returns: true if the specified point is visible in the wrapped viewport, false otherwise.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ pointInViewport()

virtual bool OdGsView::pointInViewport ( const OdGePoint2d & screenPoint ) const

pure virtual

Checks whether the specified point is inside viewport area.

Parameters

screenPoint [in] Check point in device coordinate space.

Returns: true if the passed point is inside the viewport, false otherwise.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ position()

virtual OdGePoint3d OdGsView::position ( ) const

pure virtual

Returns the WCS camera position for this Viewport object.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ projectionMatrix()

virtual OdGeMatrix3d OdGsView::projectionMatrix ( ) const

pure virtual

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

See also: Coordinate Systems.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ removeViewport3dClipping()

void OdGsView::removeViewport3dClipping ( )

Removes the 3d clipping from this Viewport object.

◆ removeViewportClipRegion()

void OdGsView::removeViewportClipRegion ( )

Removes the polygonal clip region for this Viewport object.

◆ roll()

virtual void OdGsView::roll ( double rollAngle )

pure virtual

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 position to the target. The X-axis is the cross product Y-axis x Z-axis. All angles are expressed in radians.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ rootDrawableAt()

virtual OdGiDrawablePtr OdGsView::rootDrawableAt	(	int	i,
		OdGsModelPtr *	pModelReturn = `0`
	)		const

pure virtual

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ rootDrawableIdAt()

virtual OdDbStub * OdGsView::rootDrawableIdAt	(	int	i,
		OdGsModelPtr *	pModelReturn = `0`
	)		const

pure virtual

Retrieves a persistent object identifier of the root drawable at the specified index.

Parameters

i	[in] Index of the drawable to return.
pModelReturn	[in] Index of the drawable to return.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ screenMatrix()

virtual OdGeMatrix3d OdGsView::screenMatrix ( ) const

pure virtual

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

See also: Coordinate Systems.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ select()

virtual void OdGsView::select	(	const OdGsDCPoint *	pts,
		int	nPoints,
		OdGsSelectionReactor *	pReactor,
		OdGsView::SelectionMode	mode = `OdGsView::kCrossing`
	)

pure virtual

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.

See also: <link tv_working_with_features_selections, Work with Selections>

Implemented in OdGsViewImpl, and OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >.

◆ setAlternateLinetypeScaleMultiplier()

virtual void OdGsView::setAlternateLinetypeScaleMultiplier ( double linetypeAlternateScaleMultiplier )

pure virtual

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.

See also: <exref target="https://docs.opendesign.com/td/db_linetype.html">Working with Linetypes</exref>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setBackClip()

virtual void OdGsView::setBackClip ( double backClip )

pure virtual

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

Parameters

backClip [in] Back clip distance.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setBackground()

virtual void OdGsView::setBackground ( OdDbStub * backgroundId )

pure virtual

Sets background object for this view.

Parameters

backgroundId [in] New background object ID.

See also: <link tv_working_with_attributes_view_backgrounds, Work with View Backgrounds>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setClearColor()

virtual void OdGsView::setClearColor ( ClearColor color )

pure virtual

Sets the clear color for this view

Parameters

color [in] The clear color.

Implemented in OdGsViewImpl, and OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >.

◆ setEnableBackClip()

virtual void OdGsView::setEnableBackClip ( bool enable )

pure virtual

Controls the back clipping of this Viewport object.

Parameters

enable [in] Enable back clipping.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setEnableFrontClip()

virtual void OdGsView::setEnableFrontClip ( bool enable )

pure virtual

Controls the front clipping of this Viewport object.

Parameters

enable [in] Enable front clipping.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setFrontClip()

virtual void OdGsView::setFrontClip ( double frontClip )

pure virtual

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

Parameters

frontClip [in] Front clip distance.

Implemented in OdGsViewImpl, and OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >.

◆ setLensLength()

virtual void OdGsView::setLensLength ( double lensLength )

pure virtual

Sets the perspective lens length for this Viewport object.

Parameters

lensLength [in] Perspective lens length.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setLinetypeScaleMultiplier()

virtual void OdGsView::setLinetypeScaleMultiplier ( double linetypeScaleMultiplier )

pure virtual

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

Parameters

linetypeScaleMultiplier [in] Linetype scale multiplier.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setLineweightEnum()

virtual void OdGsView::setLineweightEnum	(	int	numLineweights,
		const OdUInt8 *	lineweights
	)

pure virtual

Sets the lineweights for this Viewport object.

Parameters

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

See also: <link tv_working_with_attributes_lineweights, Work with Lineweights>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setLineweightToDcScale()

virtual void OdGsView::setLineweightToDcScale ( double scale )

pure virtual

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

Parameters

scale [in] Scale factor.

See also: <link tv_working_with_attributes_lineweights, Work with Lineweights>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setMode()

virtual void OdGsView::setMode ( RenderMode mode )

pure virtual

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setStereoParameters()

virtual void OdGsView::setStereoParameters	(	double	magnitude,
		double	parallax
	)

pure virtual

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setUserGiContext()

virtual void OdGsView::setUserGiContext ( OdGiContext * pUserGiContext )

pure virtual

Sets the User Context object associated with this Viewport object.

Parameters

pUserGiContext [in] Pointer to the User Context.

Implemented in OdGsBaseVectorizeView, and OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >.

◆ setView()

virtual void OdGsView::setView	(	const OdGePoint3d &	position,
		const OdGePoint3d &	target,
		const OdGeVector3d &	upVector,
		double	fieldWidth,
		double	fieldHeight,
		Projection	projectionType = `kParallel`
	)

pure virtual

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: This method defines the transfomation from WCS coordinates to normalized device coordinates. All parameters are in WCS coordinates. projectionType must be one of the following:

Value kParallel 0 kPerspective 1

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setViewport() [1/3]

virtual void OdGsView::setViewport	(	const OdGePoint2d &	lowerLeft,
		const OdGePoint2d &	upperRight
	)

pure virtual

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].

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setViewport() [2/3]

virtual void OdGsView::setViewport ( const OdGsDCRect & screenRect )

pure virtual

Sets the size and position of this Viewport object.

Parameters

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setViewport() [3/3]

virtual void OdGsView::setViewport ( const OdGsDCRectDouble & screenRect )

virtual

Sets the size and position of this Viewport object.

Parameters

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.

Reimplemented in OdGsViewImpl, and OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >.

◆ setViewport3dClipping()

virtual void OdGsView::setViewport3dClipping	(	const OdGiClipBoundary *	pBoundary,
		const OdGiAbstractClipBoundary *	pClipInfo = `NULL`
	)

virtual

Defines the 3d clipping for this Viewport object.

Parameters

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

Reimplemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setViewportBorderProperties()

virtual void OdGsView::setViewportBorderProperties	(	ODCOLORREF	color,
		int	width
	)

pure virtual

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

Parameters

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

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setViewportBorderVisibility()

virtual void OdGsView::setViewportBorderVisibility ( bool visible )

pure virtual

Controls the border visibility for this Viewport object.

Parameters

visible [in] Controls visibility.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setViewportClipRegion() [1/2]

virtual void OdGsView::setViewportClipRegion	(	int	numContours,
		int const *	numVertices,
		OdGePoint2d const *	vertices
	)

pure virtual

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.

Implemented in OdGsViewImpl, and OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >.

◆ setViewportClipRegion() [2/2]

virtual void OdGsView::setViewportClipRegion	(	int	numContours,
		int const *	numVertices,
		OdGsDCPoint const *	vertices
	)

pure virtual

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setVisualStyle() [1/2]

virtual void OdGsView::setVisualStyle ( const OdGiVisualStyle & visualStyle )

pure virtual

Sets visual style for this view.

Parameters

visualStyle [in] New visual style data.

See also: <link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Implemented in OdGsBaseVectorizeViewJoin< BaseVectorizerObject >, OdGsBaseVectorizeViewJoin< OdGsBaseMaterialViewPC >, OdGsBaseVectorizeViewJoin< OdGsBaseVectorizer >, OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ setVisualStyle() [2/2]

virtual void OdGsView::setVisualStyle ( OdDbStub * visualStyleId )

pure virtual

Sets visual style object for this view.

Parameters

visualStyleId [in] New visual style object ID.

See also: <link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ show()

virtual void OdGsView::show ( )

pure virtual

Un-hides this Viewport object.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ ssaoMode()

virtual bool OdGsView::ssaoMode ( ) const

pure virtual

Returns ambient occlusion mode for current Viewport object.

Returns: true if ambient occlusion enabled for current view or false otherwise.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ target()

virtual OdGePoint3d OdGsView::target ( ) const

pure virtual

Returns the WCS camera target for this Viewport object.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ thawLayer()

virtual void OdGsView::thawLayer ( OdDbStub * layerID )

pure virtual

Thaws the specified Layer object in this Viewport object.

Parameters

layerID [in] Layer to thaw.

Remarks: All layers are thawed by default.

See also: <link tv_working_with_attributes_layers, Work with Layers>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ update()

virtual void OdGsView::update ( )

pure virtual

Flushes any queued graphics to the display device.

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

Implemented in OdGsBaseVectorizeView, and OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >.

◆ upVector()

virtual OdGeVector3d OdGsView::upVector ( ) const

pure virtual

Returns the WCS camera up vector for this Viewport object.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ userGiContext()

virtual OdGiContext * OdGsView::userGiContext ( ) const

pure virtual

Returns the GiContext object associated with this Viewport object.

Implemented in OdGsBaseVectorizeView, and OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >.

◆ viewingMatrix()

virtual OdGeMatrix3d OdGsView::viewingMatrix ( ) const

pure virtual

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

See also: Coordinate Systems.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ viewParameters()

virtual void OdGsView::viewParameters ( OdGsView * pView ) const

pure virtual

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

Parameters

pView [out] Receives the view parameters.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ viewport3dClipping()

virtual const OdGiClipBoundary * OdGsView::viewport3dClipping ( const OdGiAbstractClipBoundary ** ppClipInfo = NULL ) const

virtual

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 in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ viewportClipRegion() [1/2]

virtual void OdGsView::viewportClipRegion	(	OdIntArray &	counts,
		OdGePoint2dArray &	vertices
	)		const

pure virtual

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ viewportClipRegion() [2/2]

virtual void OdGsView::viewportClipRegion	(	OdIntArray &	counts,
		OdGsDCPointArray &	vertices
	)		const

pure virtual

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.

Implemented in OdGsViewImpl, and OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >.

◆ visualStyle() [1/2]

virtual OdDbStub * OdGsView::visualStyle ( ) const

pure virtual

Returns current visual style object ID for this view.

See also: <link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ visualStyle() [2/2]

virtual bool OdGsView::visualStyle ( OdGiVisualStyle & visualStyle ) const

pure virtual

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.

See also: <link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ worldToDeviceMatrix()

virtual OdGeMatrix3d OdGsView::worldToDeviceMatrix ( ) const

pure virtual

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ zoom()

virtual void OdGsView::zoom ( double zoomFactor )

pure virtual

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

Parameters

zoomFactor [in] Zoom factor.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ zoomExtents()

virtual void OdGsView::zoomExtents	(	const OdGePoint3d &	minPt,
		const OdGePoint3d &	maxPt
	)

pure virtual

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.

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

◆ zoomWindow()

virtual void OdGsView::zoomWindow	(	const OdGePoint2d &	lowerLeft,
		const OdGePoint2d &	upperRight
	)

pure virtual

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].

Implemented in OdGsViewWrapper< OdGsView, OdGsDefaultRedirectionBase< OdGsView, OdGsView > >, and OdGsViewImpl.

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

Gs.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ClearColor

◆ DefaultLightingType

◆ Projection

◆ RenderMode

◆ SelectionMode

◆ ViewUpdateFlags

Member Function Documentation

◆ add()

◆ antiAliasingMode()

◆ backClip()

◆ background()

◆ beginInteractivity()

◆ clearFrozenLayers()

◆ clientViewInfo()

◆ cloneView()

◆ collide()

◆ device()

◆ dolly() [1/2]

◆ dolly() [2/2]

◆ enableAntiAliasing()

◆ enableDefaultLighting()

◆ enableSSAO()

◆ enableStereo()

◆ endInteractivity()

◆ erase()

◆ eraseAll()

◆ exceededBounds()

◆ extentsInView()

◆ fieldHeight()

◆ fieldWidth()

◆ flush()

◆ freezeLayer()

◆ frontClip()

◆ getModel()

◆ getModelList()

◆ getNumPixelsInUnitSquare()

◆ getSnapShot()

◆ getStereoParameters()

◆ getViewport() [1/3]

◆ getViewport() [2/3]

◆ getViewport() [3/3]

◆ getViewportBorderProperties()

◆ hide()

◆ initLights()

◆ interactivityFrameRate()

◆ invalidate() [1/2]

◆ invalidate() [2/2]

◆ invalidateCachedViewportGeometry()

◆ isBackClipped()

◆ isFrontClipped()

◆ isInInteractivity()

◆ isPerspective()

◆ isStereoEnabled()

◆ isValid()

◆ isViewportBorderVisible()

◆ isVisible()

◆ lensLength()

◆ linetypeAlternateScaleMultiplier()

◆ linetypeScaleMultiplier()

◆ lineweightToDcScale()

◆ mode()

◆ numRootDrawables()

◆ objectToDeviceMatrix()

◆ ODRX_DECLARE_MEMBERS()

◆ orbit()

◆ pan()

◆ pointInView()

◆ pointInViewport()

◆ position()

◆ projectionMatrix()

◆ removeViewport3dClipping()

◆ removeViewportClipRegion()

◆ roll()

◆ rootDrawableAt()

◆ rootDrawableIdAt()