CFx SDK Documentation  2022 SP0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
OdGsViewImpl Class Referenceabstract

#include <GsViewImpl.h>

Inheritance diagram for OdGsViewImpl:
OdGsView OdRxObject OdGsBaseVectorizeView OdGsBaseVectorizeViewJoin< OdGsBaseVectorizer > OdGsBaseVectorizeViewJoin< OdGsBaseMaterialViewPC > OdGsBaseVectorizeViewJoin< BaseVectorizerObject > OdGsBaseVectorizeViewJoinMT< OdGsBaseVectorizer > OdGsBaseVectorizeViewDef OdGsBaseVectorizeViewJoinMT< OdGsBaseMaterialViewPC > OdGsBaseMaterialView OdGsBaseVectorizeViewJoinMT< BaseVectorizerObject > OdGsBaseVectorizeViewMT OdGsBaseMaterialViewMT

Classes

struct  GsViewOverlayData
 
class  GsViewOverlayDataContainer
 

Public Types

enum  ProjectionMatrixFlags {
  kProjectionIncludeDept = (1 << 0) , kProjectionIncludeClip = (1 << 1) , kProjectionIncludePerspective = (1 << 2) , kProjectionIncludeRotation = (1 << 3) ,
  kProjectionIncludeAll = 0x0F , kProjectionIncludeAllNoDept = kProjectionIncludeAll & ~kProjectionIncludeDept
}
 
- 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 }
 

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGsViewImpl)
 
 OdGsViewImpl ()
 
 ~OdGsViewImpl ()
 
virtual void init (OdGsBaseVectorizeDevice *pDevice, const OdGsClientViewInfo *pViewInfo=0, bool enableLayerVisibilityPerView=false)
 
virtual OdGsDevicedevice () const
 
virtual void clientViewInfo (OdGsClientViewInfo &viewInfo) const
 
virtual RenderMode mode () const
 
bool setModeOverride (RenderMode mode)
 
virtual void setMode (RenderMode mode)
 
virtual void freezeLayer (OdDbStub *layerID)
 
virtual void thawLayer (OdDbStub *layerID)
 
virtual void clearFrozenLayers ()
 
virtual void setViewportBorderProperties (ODCOLORREF color, int width)
 
virtual void getViewportBorderProperties (ODCOLORREF &color, int &width) const
 
virtual void setViewportBorderVisibility (bool visible)
 
virtual bool isViewportBorderVisible () const
 
virtual void setEnableFrontClip (bool enable)
 
virtual bool isFrontClipped () const
 
virtual void setFrontClip (double distance)
 
virtual double frontClip () const
 
virtual void setEnableBackClip (bool enable)
 
virtual bool isBackClipped () const
 
virtual void setBackClip (double distance)
 
virtual double backClip () const
 
virtual OdGePoint3d position () const
 
virtual OdGePoint3d target () const
 
virtual OdGeVector3d upVector () const
 
virtual double fieldWidth () const
 
virtual double fieldHeight () const
 
double windowAspect () const
 
virtual double lensLength () const
 
virtual void setLensLength (double lensLength)
 
virtual bool isPerspective () const
 
virtual void beginInteractivity (double frameRateInHz)
 
virtual bool isInInteractivity () const
 
virtual double interactivityFrameRate () const
 
virtual void endInteractivity ()
 
virtual void flush ()
 
virtual void hide ()
 
virtual void show ()
 
virtual bool isVisible ()
 
virtual OdGsViewPtr cloneView (bool cloneViewParameters=true, bool cloneGeometry=false)
 
virtual bool exceededBounds ()
 
virtual void enableStereo (bool enabled)
 
virtual bool isStereoEnabled () const
 
virtual void setStereoParameters (double magnitude, double parallax)
 
virtual void getStereoParameters (double &magnitude, double &parallax) const
 
virtual void initLights (OdRxIterator *pLightsIterator)
 
virtual void getSnapShot (OdGiRasterImagePtr &pImage, const OdGsDCRect &region)
 
virtual void setViewport (const OdGePoint2d &lowerLeft, const OdGePoint2d &upperRight)
 
virtual void setViewport (const OdGsDCRect &screenRect)
 
virtual void setViewport (const OdGsDCRectDouble &screenRec)
 
virtual void getViewport (OdGePoint2d &lowerLeft, OdGePoint2d &upperRight) const
 
virtual void getViewport (OdGsDCRect &screenRect) const
 
virtual void getViewport (OdGsDCRectDouble &screenRec) const
 
virtual OdGeMatrix3d screenMatrix () const
 
virtual OdGeMatrix3d worldToDeviceMatrix () const
 
virtual OdGeMatrix3d objectToDeviceMatrix () const
 
virtual OdGeMatrix3d viewingMatrix () const
 
virtual OdGeMatrix3d projectionMatrix () const
 
virtual void viewParameters (OdGsView *pView) const
 
virtual double lineweightToDcScale () const
 
virtual void setLineweightToDcScale (double scale)
 
virtual void setLineweightEnum (int numLineweights, const OdUInt8 *lineweights)
 
virtual void setLinetypeScaleMultiplier (double linetypeScaleMultiplier)
 
virtual void setAlternateLinetypeScaleMultiplier (double linetypeAlternateScaleMultiplier)
 
virtual double linetypeScaleMultiplier () const
 
virtual void dolly (const OdGeVector3d &dollyVector)
 
virtual void dolly (double xDolly, double yDolly, double zDolly)
 
virtual void roll (double rollAngle)
 
virtual void orbit (double xOrbit, double yOrbit)
 
virtual void zoom (double zoomFactor)
 
virtual void pan (double xPan, double yPan)
 
virtual void setView (const OdGePoint3d &position, const OdGePoint3d &target, const OdGeVector3d &upVector, double fieldWidth, double fieldHeight, Projection projection=kParallel)
 
virtual void zoomExtents (const OdGePoint3d &minPt, const OdGePoint3d &maxPt)
 
virtual void zoomWindow (const OdGePoint2d &lowerLeft, const OdGePoint2d &upperRight)
 
virtual bool pointInView (const OdGePoint3d &pt) const
 
virtual bool extentsInView (const OdGePoint3d &minPt, const OdGePoint3d &maxPt) const
 
virtual void viewportClipRegion (OdIntArray &counts, OdGePoint2dArray &vertices) const
 
virtual void viewportClipRegion (OdIntArray &counts, OdGsDCPointArray &dcPts) const
 
virtual void setViewportClipRegion (int numContours, const int *numVertices, const OdGePoint2d *vertices)
 
virtual void setViewportClipRegion (int numContours, int const *numVertices, OdGsDCPoint const *vertices)
 
bool isDependentViewportView () const
 
bool isDependentGeometryView () const
 
bool isHelperView () const
 
const OdGsBaseModulegetGsModulePtr () const
 
const OdGiContextualColorscontextualColors () const
 
void setContextualColors (OdGiContextualColors *pColors)
 
virtual bool pointInViewport (const OdGePoint2d &screenPoint) const
 
virtual void setClearColor (ClearColor color)
 
virtual void invalidate ()
 
virtual void invalidate (const OdGsDCRect &rect)
 
virtual void invalidateCachedViewportGeometry ()
 
virtual void select (const OdGsDCPoint *points, int numPoints, OdGsSelectionReactor *pReactor, SelectionMode mode=kCrossing)
 
virtual bool add (OdGiDrawable *sceneGraph, OdGsModel *model)
 
virtual bool erase (OdGiDrawable *sceneGraph)
 
virtual void eraseAll ()
 
virtual OdGsModelgetModel (const OdGiDrawable *pDrawable) const
 
virtual OdGsModelArray getModelList () const
 
virtual bool isValid () const
 
virtual void getNumPixelsInUnitSquare (const OdGePoint3d &givenWorldpt, OdGePoint2d &pixelArea, bool includePerspective=true) const
 
virtual void setBackground (OdDbStub *backgroundId)
 
virtual OdDbStub * background () const
 
virtual void setVisualStyle (OdDbStub *visualStyleId)
 
virtual OdDbStub * visualStyle () const
 
virtual void setVisualStyle (const OdGiVisualStyle &visualStyle)
 
virtual bool visualStyle (OdGiVisualStyle &vs) const
 
virtual void enableDefaultLighting (bool bEnable, DefaultLightingType lightType=kTwoLights)
 
bool defaultLightingEnabled () const
 
DefaultLightingType defaultLightingType () const
 
OdUInt32 viewportId () const
 
bool isValidViewportId (const OdUInt32 vpId) const
 
OdDbStub * getViewportObjectId () const
 
OdGsBaseVectorizeDevicebaseDevice ()
 
const OdGsBaseVectorizeDevicebaseDevice () const
 
OdDbStub * annotationScaleId () const
 
OdIntPtr drawablesFilterFunction () const
 
virtual bool viewExtents (OdGeBoundBlock3d &extents) const =0
 
virtual void select (const OdGePoint2d *aPtDc, int numPoints, OdGsSelectionReactor *pReactor, SelectionMode mode=kCrossing)=0
 
bool isSnapping () const
 
void setSnapping (bool val)
 
bool isRegenOnDrawForbidden () const
 
void setRegenOnDrawForbidden (bool val)
 
bool isAccumulateVpChanges () const
 
virtual void clearLinetypeCache ()=0
 
double linetypeAlternateScaleMultiplier () const
 
virtual bool isSupportLegacyWireframeMode () const
 
virtual bool isLegacyWireframeMode () const
 
virtual void setLegacyWireframeMode (bool bSet)
 
virtual bool isSupportLegacyHiddenMode () const
 
virtual bool isLegacyHiddenMode () const
 
virtual void setLegacyHiddenMode (bool bSet)
 
bool isSupportPlotStyles () const
 
virtual bool isPlotTransparency () const
 
virtual void setPlotTransparency (bool bSet)
 
OdUInt32 frozenLayers () const
 
void frozenLayers (OdDbStubPtrArray &frozenLayers) const
 
bool isLayerVisible (OdDbStub *layerId) const
 
int lineweightToPixels (OdDb::LineWeight lineweight) const
 
double lineweightToPixels (double lineweight) const
 
void screenRect (OdGsDCPoint &lowerLeft, OdGsDCPoint &upperRight) const
 
void screenRect (OdGePoint2d &lowerLeft, OdGePoint2d &upperRight) const
 
void screenRectNorm (OdGsDCRect &normalizedRect) const
 
void viewportDcCorners (OdGePoint2d &lower_left, OdGePoint2d &upper_right) const
 
bool doPerspectivePt (OdGePoint3d &point) const
 
bool doInversePerspectivePt (OdGePoint3d &point) const
 
const OdGeMatrix3deyeToWorldMatrix () const
 
const OdGeMatrix3dworldToEyeMatrix () const
 
OdGeMatrix3d eyeToScreenMatrix (OdGsOverlayId nOverlay=kGsMainOverlay) const
 
OdGeMatrix3d worldToDeviceMatrix (OdGsOverlayId nOverlay) const
 
OdGeMatrix3d objectToDeviceMatrix (OdGsOverlayId nOverlay) const
 
OdGeMatrix3d projectionMatrix (OdUInt32 nIncludes, OdGsOverlayId nOverlay=kGsMainOverlay) const
 
ClearColor clearColor () const
 
virtual void invalidate (const OdGeExtents3d &worldExt, const OdGsModel *pModel, OdDb::LineWeight extendByLineweight=OdDb::kLnWt000)
 
void invalidate (const OdGsUpdateExtents &extents, const OdGsModel *pModel)
 
void invalidateRegion (const OdGiPathNode &path)
 
OdGsDCRectArray invalidRects (OdGsOverlayId nOverlay=kGsMainOverlay) const
 
bool isViewportOnScreen () const
 
bool isCompletelyVisible () const
 
void setCompletelyVisible (bool val)
 
void setInversion (bool invertedX, bool invertedY)
 
OdGiRegenType getRegenType () const
 
double focalLength () const
 
const OdGeVector3deyeVector () const
 
const OdGeVector3dxVector () const
 
const OdGeVector3dgetUpVector () const
 
double getLinetypeScaleMultiplier () const
 
double getLinetypeGenerationCriteria () const
 
virtual double getDeviation (const OdGiDeviationType deviationType, const OdGePoint3d &pointOnCurve, bool bRecalculate=false) const
 
void initDeviation ()
 
int cachedDrawables () const
 
virtual bool isViewRegenerated () const
 
bool isNonRectClipped () const
 
bool hasLweights () const
 
const OdUInt8ArraygetLweightsEnum () const
 
const OdGePoint2ddcScreenMin () const
 
const OdGePoint2ddcScreenMax () const
 
const OdGePoint2ddcLowerLeft () const
 
const OdGePoint2ddcUpperRight () const
 
OdGeMatrix3d perspectiveMatrix () const
 
void invalidateCachedViewportGeometry (OdUInt32 mask)
 
void registerOverlay (const OdGsModel *pModel)
 
void unregisterOverlay (const OdGsModel *pModel)
 
virtual int partialUpdateExtentsEnlargement () const
 
double calcDeviation (const OdGiDeviationType type, const OdGePoint3d &pt) const
 
OdGsPropertiesPtr getViewportPropertiesRoot () const
 
bool updateViewportProperties (OdUInt32 incFlags)
 
OdGsPropertiesPtr getViewportPropertiesForType (OdGsProperties::PropertiesType type) const
 
const OdGeMatrix3drotationMatrix () const
 
short viewportRotation () const
 
bool isRotated () const
 
double unrotatedFieldHeight () const
 
double unrotatedFieldWidth () const
 
double actualFieldWidth () const
 
double actualFieldHeight () const
 
virtual void initCullingVolume ()
 
void setCullingVolume (OdGsCullingVolumePtr newVol)
 
OdGsCullingVolumePtr cullingVolume () const
 
virtual bool isCullingVolumeInitialized () const
 
virtual bool cullingVolumeIntersectWithOpt (const OdGsCullingPrimitive &prim) const
 
virtual OdGsCullingVolume::IntersectionStatus cullingVolumeIntersectWith (const OdGsCullingPrimitive &prim) const
 
virtual void cullingVolumeTransformBy (const OdGeMatrix3d &xfm)
 
virtual void setViewport3dClipping (const OdGiClipBoundary *pBoundary, const OdGiAbstractClipBoundary *pClipInfo=NULL)
 
virtual const OdGiClipBoundaryviewport3dClipping (const OdGiAbstractClipBoundary **ppClipInfo=NULL) const
 
OdGiClipBoundaryWithAbstractDataviewport3dClippingObject ()
 
bool hasViewport3dClipping () const
 
virtual bool saveViewState (OdGsFiler *pFiler) const
 
virtual bool loadViewState (OdGsFiler *pFiler)
 
virtual bool saveClientViewState (OdGsFiler *pFiler) const
 
virtual bool loadClientViewState (OdGsFiler *pFiler)
 
virtual const OdDbStubPtrArraygetFrozenLayersDiff () const
 
- Public Member Functions inherited from OdGsView
 ODRX_DECLARE_MEMBERS (OdGsView)
 
virtual OdGiContextuserGiContext () const =0
 
virtual void setUserGiContext (OdGiContext *pUserGiContext)=0
 
void removeViewportClipRegion ()
 
void removeViewport3dClipping ()
 
virtual void update ()=0
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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
 

Static Public Member Functions

static OdGsViewImplsafeCast (OdGsView *pView)
 
static const OdGsViewImplsafeCast (const OdGsView *pView)
 
static double lensLengthToFOV (double lensLength)
 
static double lensLengthFromFOV (double fovAngle)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Protected Member Functions

virtual bool sceneDept (double &zNear, double &zFar, OdGsOverlayId nOverlay) const
 
virtual bool sceneDept (double &zNear, double &zFar) const
 
virtual bool usesDept (double *pMinDeptSupported=0, double *pMaxDeptSupported=0) const
 
void onWorldToEyeChanged ()
 
void onFinalRelease ()
 
virtual void updateViewProps (bool bFullUpdate=true)
 
bool isCheckValid () const
 
void setCheckValid (bool bValue) const
 
bool isInvalid () const
 
void setInvalid (bool bValue) const
 
void setPerspectiveEnabled (bool bValue) const
 
OdGiDrawablePtr drawableAt (DrawableHolder &drawableHolder)
 
OdGsNodegetRootNode (DrawableHolder &holder)
 
virtual void propagateInvalidVpFlag ()
 
virtual void propagateLayersChanges ()
 

Protected Attributes

OdGsBaseModulePtr m_pModule
 
OdDbStubPtrArray m_lastFrozenLayers
 
OdDbStubPtrArray m_frozenLayersDiff
 
OdUInt32 m_gsViewImplFlags
 
ODCOLORREF m_borderColor
 
int m_borderWeight
 
double m_frontClipDist
 
double m_backClipDist
 
bool m_screenInvertedX
 
bool m_screenInvertedY
 
OdGePoint2d m_dcScreenMin
 
OdGePoint2d m_dcScreenMax
 
OdGePoint2d m_dcLowerLeft
 
OdGePoint2d m_dcUpperRight
 
double m_fieldWidth
 
double m_fieldHeight
 
double m_lensLength
 
double m_eyeVecLength
 
OdGePoint3d m_position
 
OdGePoint3d m_target
 
OdGeVector3d m_upVector
 
OdGeVector3d m_eyeVector
 
OdGeVector3d m_xVector
 
OdGeMatrix3d m_eyeToWorld
 
OdGeMatrix3d m_worldToEye
 
OdIntArray m_nrcCounts
 
OdGePoint2dArray m_nrcPoints
 
double m_linetypeScaleMultiplier
 
double m_linetypeAlternateScaleMultiplier
 
double m_lineweightToDcScale
 
OdUInt8Array m_lweights
 
OdGsCullingVolumePtr m_pCullingVolume
 
OdSharedPtr< OdGiClipBoundaryWithAbstractDatam_p3dClip
 
double m_deviation [5]
 
int m_nCachedDrawables
 
OdMutex m_mtExtents
 
OdGsPropertiesPtr m_pProperties
 
OdDbStub * m_pBackgroundId
 
OdDbStub * m_pVisualStyleId
 
OdGiDrawablePtr m_pViewportTrans
 
DefaultLightingType m_defaultLightingType
 
GsViewOverlayDataContainer m_overlayData
 
OdGsBaseVectorizeDevicem_pDevice
 
OdGsClientViewInfo m_viewInfo
 
OdUInt32 m_giViewportId
 
OdGiRegenType m_regenerationType
 
OdRxObjectPtr m_pGsReserved
 
RenderMode m_renderMode
 
DrawableHolderArray m_drawables
 
OdDbStubPtrArray m_frozenLayers
 
bool m_bInInteractivityMode
 
double m_dInteractivityFrameRate
 

Friends

class GsViewImplHelper
 
class OdGiBaseVectorizerImpl
 
class OdGsBaseVectorizer
 
class OdGsBaseModule
 
class OdGsBaseVectorizeDevice
 

Detailed Description

This class implements Viewport objects in GUI display windows.

Corresponding C++ library: Gs

<group OdGs_Classes>

Definition at line 57 of file GsViewImpl.h.

Member Enumeration Documentation

◆ ProjectionMatrixFlags

Enumerator
kProjectionIncludeDept 
kProjectionIncludeClip 
kProjectionIncludePerspective 
kProjectionIncludeRotation 
kProjectionIncludeAll 
kProjectionIncludeAllNoDept 

Definition at line 348 of file GsViewImpl.h.

Constructor & Destructor Documentation

◆ OdGsViewImpl()

OdGsViewImpl::OdGsViewImpl ( )

◆ ~OdGsViewImpl()

OdGsViewImpl::~OdGsViewImpl ( )

Member Function Documentation

◆ actualFieldHeight()

double OdGsViewImpl::actualFieldHeight ( ) const
inline

Returns actual field height variable (without inclusion if aspect ratio).

Definition at line 993 of file GsViewImpl.h.

◆ actualFieldWidth()

double OdGsViewImpl::actualFieldWidth ( ) const
inline

Returns actual field width variable (without inclusion if aspect ratio).

Definition at line 988 of file GsViewImpl.h.

◆ add()

virtual bool OdGsViewImpl::add ( OdGiDrawable pSceneGraph,
OdGsModel pModel 
)
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:
  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.

◆ annotationScaleId()

OdDbStub* OdGsViewImpl::annotationScaleId ( ) const

◆ backClip()

virtual double OdGsViewImpl::backClip ( ) const
virtual

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

Implements OdGsView.

◆ background()

virtual OdDbStub* OdGsViewImpl::background ( ) const
virtual

Returns current background object ID for this view.

Implements OdGsView.

◆ baseDevice() [1/2]

OdGsBaseVectorizeDevice* OdGsViewImpl::baseDevice ( )
inline

Returns the OdGsBaseVectorizeDevice associated with this Viewport object.

Definition at line 249 of file GsViewImpl.h.

◆ baseDevice() [2/2]

const OdGsBaseVectorizeDevice* OdGsViewImpl::baseDevice ( ) const
inline

Definition at line 250 of file GsViewImpl.h.

◆ beginInteractivity()

virtual void OdGsViewImpl::beginInteractivity ( double  frameRateInHz)
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.

Implements OdGsView.

◆ cachedDrawables()

int OdGsViewImpl::cachedDrawables ( ) const
inline

Returns the number of cached drawables for this view object.

Definition at line 409 of file GsViewImpl.h.

◆ calcDeviation()

double OdGsViewImpl::calcDeviation ( const OdGiDeviationType  type,
const OdGePoint3d pt 
) const

◆ clearColor()

ClearColor OdGsViewImpl::clearColor ( ) const

◆ clearFrozenLayers()

virtual void OdGsViewImpl::clearFrozenLayers ( )
virtual

Thaws all Layer objects in this Viewport object.

Remarks
All layers are thawed by default.

Implements OdGsView.

◆ clearLinetypeCache()

virtual void OdGsViewImpl::clearLinetypeCache ( )
pure virtual

◆ clientViewInfo()

virtual void OdGsViewImpl::clientViewInfo ( OdGsClientViewInfo clientViewInfo) const
virtual

Returns the ClientViewInfo for this Viewport object.

Parameters
clientViewInfo[out] Receives the ClientViewInfo.

Reimplemented from OdGsView.

◆ cloneView()

virtual OdGsViewPtr OdGsViewImpl::cloneView ( bool  cloneViewParameters = true,
bool  cloneGeometry = false 
)
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.

Implements OdGsView.

◆ contextualColors()

const OdGiContextualColors * OdGsViewImpl::contextualColors ( ) const
inline

Definition at line 846 of file GsViewImpl.h.

◆ cullingVolume()

OdGsCullingVolumePtr OdGsViewImpl::cullingVolume ( ) const

Returns culling volume associated with current view.

See also
initCullingVolume setCullingVolume

◆ cullingVolumeIntersectWith()

virtual OdGsCullingVolume::IntersectionStatus OdGsViewImpl::cullingVolumeIntersectWith ( const OdGsCullingPrimitive prim) const
virtual

Complete intersection test between culling volume associated with current view and culling primitive.

Returns
Returns kIntersectIn intersection status if culling volume is not initialized.
Remarks
Return value intersection statuses:
Value Description kIntersectNot 0 No intersection detected. kIntersectOk 1 Intersects with culling volume boundary. kIntersectIn 2 Culling volume primitive is completely inside culling volume boundary.
Parameters
prim[in] Input primitive for culling detection.
See also
isCullingVolumeInitialized cullingVolumeIntersectWithOpt

◆ cullingVolumeIntersectWithOpt()

virtual bool OdGsViewImpl::cullingVolumeIntersectWithOpt ( const OdGsCullingPrimitive prim) const
virtual

Optimized intersection test between culling volume associated with current view and culling primitive.

Returns
Returns true if culling volume is not initialized.
Parameters
prim[in] Input primitive for culling detection.
See also
isCullingVolumeInitialized cullingVolumeIntersectWith

◆ cullingVolumeTransformBy()

virtual void OdGsViewImpl::cullingVolumeTransformBy ( const OdGeMatrix3d xfm)
virtual

Applies transformation for culling volume associated with current view.

Parameters
xfm[in] Transformation matrix.
See also
initCullingVolume

◆ dcLowerLeft()

const OdGePoint2d& OdGsViewImpl::dcLowerLeft ( ) const
inline

Definition at line 476 of file GsViewImpl.h.

◆ dcScreenMax()

const OdGePoint2d& OdGsViewImpl::dcScreenMax ( ) const
inline

Definition at line 475 of file GsViewImpl.h.

◆ dcScreenMin()

const OdGePoint2d& OdGsViewImpl::dcScreenMin ( ) const
inline

Definition at line 474 of file GsViewImpl.h.

◆ dcUpperRight()

const OdGePoint2d& OdGsViewImpl::dcUpperRight ( ) const
inline

Definition at line 477 of file GsViewImpl.h.

◆ defaultLightingEnabled()

bool OdGsViewImpl::defaultLightingEnabled ( ) const
inline

Definition at line 887 of file GsViewImpl.h.

◆ defaultLightingType()

OdGsView::DefaultLightingType OdGsViewImpl::defaultLightingType ( ) const
inline

Definition at line 892 of file GsViewImpl.h.

◆ device()

virtual OdGsDevice* OdGsViewImpl::device ( ) const
virtual

Returns the GsDevice object associated with this Viewport object.

Implements OdGsView.

◆ doInversePerspectivePt()

bool OdGsViewImpl::doInversePerspectivePt ( OdGePoint3d point) const

◆ dolly() [1/2]

virtual void OdGsViewImpl::dolly ( const OdGeVector3d dollyVector)
virtual

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.

◆ dolly() [2/2]

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

Implements OdGsView.

◆ doPerspectivePt()

bool OdGsViewImpl::doPerspectivePt ( OdGePoint3d point) const

◆ drawableAt()

OdGiDrawablePtr OdGsViewImpl::drawableAt ( DrawableHolder drawableHolder)
protected

Returns the OdGiDrawable associated with the specified DrawableHolder object.

Parameters
drawableHolder[in] Drawable holder.

◆ drawablesFilterFunction()

OdIntPtr OdGsViewImpl::drawablesFilterFunction ( ) const

◆ enableDefaultLighting()

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

Enables default lighting for this view.

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

Implements OdGsView.

◆ enableStereo()

virtual void OdGsViewImpl::enableStereo ( bool  enabled)
virtual

Controls stereo viewing for this Viewport object.

Parameters
enable[in] Controls stereo viewing.

Implements OdGsView.

◆ endInteractivity()

virtual void OdGsViewImpl::endInteractivity ( )
virtual

Removes this Viewport object from the interactive state.

Parameters
frameRateInHz[in] Frames/second.

Implements OdGsView.

◆ erase()

virtual bool OdGsViewImpl::erase ( OdGiDrawable sceneGraph)
virtual

Removes the specified scene graph from this Viewport object.

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

Implements OdGsView.

◆ eraseAll()

virtual void OdGsViewImpl::eraseAll ( )
virtual

Removes all scene graphs from this Viewport object.

Parameters
sceneGraph[in] Root of scene graph.

Implements OdGsView.

◆ exceededBounds()

virtual bool OdGsViewImpl::exceededBounds ( )
virtual

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.

◆ extentsInView()

virtual bool OdGsViewImpl::extentsInView ( const OdGePoint3d minPt,
const OdGePoint3d maxPt 
) const
virtual

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.

◆ eyeToScreenMatrix()

OdGeMatrix3d OdGsViewImpl::eyeToScreenMatrix ( OdGsOverlayId  nOverlay = kGsMainOverlay) const

◆ eyeToWorldMatrix()

const OdGeMatrix3d & OdGsViewImpl::eyeToWorldMatrix ( ) const
inline

Definition at line 913 of file GsViewImpl.h.

◆ eyeVector()

const OdGeVector3d& OdGsViewImpl::eyeVector ( ) const
inline

Definition at line 395 of file GsViewImpl.h.

◆ fieldHeight()

virtual double OdGsViewImpl::fieldHeight ( ) const
virtual

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

Implements OdGsView.

◆ fieldWidth()

virtual double OdGsViewImpl::fieldWidth ( ) const
virtual

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

Implements OdGsView.

◆ flush()

virtual void OdGsViewImpl::flush ( )
virtual

Flushes the graphic pipeline and renders this Viewport object.

Remarks
This function should be called only during interactivty.

Implements OdGsView.

◆ focalLength()

double OdGsViewImpl::focalLength ( ) const

Returns the WCS (ECS) focal length of the lens for this view object.

◆ freezeLayer()

virtual void OdGsViewImpl::freezeLayer ( OdDbStub *  layerID)
virtual

Freezes the specified Layer object in this Viewport object.

Parameters
layerID[in] Layer to freeze.
Remarks
All layers are thawed by default.

Implements OdGsView.

◆ frontClip()

virtual double OdGsViewImpl::frontClip ( ) const
virtual

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

Implements OdGsView.

◆ frozenLayers() [1/2]

OdUInt32 OdGsViewImpl::frozenLayers ( ) const
inline

Returns the frozen layers for this view object.

Remarks
Returns true if and only if there are any frozen layers.

Definition at line 299 of file GsViewImpl.h.

◆ frozenLayers() [2/2]

void OdGsViewImpl::frozenLayers ( OdDbStubPtrArray frozenLayers) const
inline

Returns the frozen layers for this view object.

Parameters
frozenLayers[out] Receives an array of frozen layer Object IDs.
Remarks
If called without the frozenLayers argument, returns true if and only if there are any frozen layers.

Definition at line 310 of file GsViewImpl.h.

◆ getDeviation()

virtual double OdGsViewImpl::getDeviation ( const OdGiDeviationType  deviationType,
const OdGePoint3d pointOnCurve,
bool  bRecalculate = false 
) const
virtual

◆ getFrozenLayersDiff()

virtual const OdDbStubPtrArray& OdGsViewImpl::getFrozenLayersDiff ( ) const
virtual

◆ getGsModulePtr()

const OdGsBaseModule * OdGsViewImpl::getGsModulePtr ( ) const
inline

Definition at line 841 of file GsViewImpl.h.

◆ getLinetypeGenerationCriteria()

double OdGsViewImpl::getLinetypeGenerationCriteria ( ) const

◆ getLinetypeScaleMultiplier()

double OdGsViewImpl::getLinetypeScaleMultiplier ( ) const

◆ getLweightsEnum()

const OdUInt8Array& OdGsViewImpl::getLweightsEnum ( ) const
inline

Definition at line 472 of file GsViewImpl.h.

◆ getModel()

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

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

Parameters
pDrawable[in] Pointer onto OdGiDrawable object.

Implements OdGsView.

◆ getModelList()

virtual OdGsModelArray OdGsViewImpl::getModelList ( ) const
virtual

Returns array of OdGsModel objects associated with this Viewport object.

Implements OdGsView.

◆ getNumPixelsInUnitSquare()

virtual void OdGsViewImpl::getNumPixelsInUnitSquare ( const OdGePoint3d point,
OdGePoint2d pixelDensity,
bool  bUsePerspective = true 
) const
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.

Implements OdGsView.

◆ getRegenType()

OdGiRegenType OdGsViewImpl::getRegenType ( ) const
inline

Definition at line 388 of file GsViewImpl.h.

◆ getRootNode()

OdGsNode* OdGsViewImpl::getRootNode ( DrawableHolder holder)
protected

◆ getSnapShot()

virtual void OdGsViewImpl::getSnapShot ( OdGiRasterImagePtr pImage,
const OdGsDCRect region 
)
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.

Implements OdGsView.

◆ getStereoParameters()

virtual void OdGsViewImpl::getStereoParameters ( double &  magnitude,
double &  parallax 
) const
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.

Implements OdGsView.

◆ getUpVector()

const OdGeVector3d& OdGsViewImpl::getUpVector ( ) const
inline

Definition at line 397 of file GsViewImpl.h.

◆ getViewport() [1/3]

virtual void OdGsViewImpl::getViewport ( OdGePoint2d lowerLeft,
OdGePoint2d upperRight 
) const
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].
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.

◆ getViewport() [2/3]

virtual void OdGsViewImpl::getViewport ( OdGsDCRect screenRect) const
virtual

Implements OdGsView.

◆ getViewport() [3/3]

virtual void OdGsViewImpl::getViewport ( OdGsDCRectDouble screenRec) const
virtual

Reimplemented from OdGsView.

◆ getViewportBorderProperties()

virtual void OdGsViewImpl::getViewportBorderProperties ( ODCOLORREF color,
int &  width 
) const
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.

Implements OdGsView.

◆ getViewportObjectId()

OdDbStub* OdGsViewImpl::getViewportObjectId ( ) const
inline

Definition at line 244 of file GsViewImpl.h.

◆ getViewportPropertiesForType()

OdGsPropertiesPtr OdGsViewImpl::getViewportPropertiesForType ( OdGsProperties::PropertiesType  type) const

◆ getViewportPropertiesRoot()

OdGsPropertiesPtr OdGsViewImpl::getViewportPropertiesRoot ( ) const

◆ hasLweights()

bool OdGsViewImpl::hasLweights ( ) const
inline

Definition at line 471 of file GsViewImpl.h.

◆ hasViewport3dClipping()

bool OdGsViewImpl::hasViewport3dClipping ( ) const
inline

Returns true if and only if 3d clipping set for this Viewport object.

Definition at line 983 of file GsViewImpl.h.

◆ hide()

virtual void OdGsViewImpl::hide ( )
virtual

Hides this Viewport object.

Implements OdGsView.

◆ init()

virtual void OdGsViewImpl::init ( OdGsBaseVectorizeDevice pDevice,
const OdGsClientViewInfo pViewInfo = 0,
bool  enableLayerVisibilityPerView = false 
)
virtual

Initializes this Viewport object.

Parameters
pDevice[in] Pointer to the OdGsBaseVectorizeDevice associated with this Viewport object.
pViewInfo[in] Pointer to the Client View Information for this Viewport object.
enableLayerVisibilityPerView[in] Layer visibility per viewport is supported, if and only if true.

◆ initCullingVolume()

virtual void OdGsViewImpl::initCullingVolume ( )
virtual

Initialize culling volume, associated with current view.

Remarks
Default implementation initializes culling volume for overall view, and transforms overall view culling volume for all viewports inside overall view space (only if viewports has orthogonal projection). This method can be overrided into user device for adjust described behaviour. If this method overrided as empty function (not create culling volume inside) - all culling functionality will be disabled.
See also
isCullingVolumeInitialized cullingVolumeIntersectWithOpt cullingVolumeIntersectWith

◆ initDeviation()

void OdGsViewImpl::initDeviation ( )

◆ initLights()

virtual void OdGsViewImpl::initLights ( OdRxIterator pLightsIterator)
virtual

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

Parameters
pLightsIterator[in] Pointer to the lights iterator.

Implements OdGsView.

◆ interactivityFrameRate()

virtual double OdGsViewImpl::interactivityFrameRate ( ) const
virtual

Returns interactivity frame rate

Implements OdGsView.

◆ invalidate() [1/4]

virtual void OdGsViewImpl::invalidate ( )
virtual

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.

◆ invalidate() [2/4]

virtual void OdGsViewImpl::invalidate ( const OdGeExtents3d worldExt,
const OdGsModel pModel,
OdDb::LineWeight  extendByLineweight = OdDb::kLnWt000 
)
virtual

◆ invalidate() [3/4]

virtual void OdGsViewImpl::invalidate ( const OdGsDCRect rect)
virtual

Implements OdGsView.

◆ invalidate() [4/4]

void OdGsViewImpl::invalidate ( const OdGsUpdateExtents extents,
const OdGsModel pModel 
)
inline

Definition at line 908 of file GsViewImpl.h.

◆ invalidateCachedViewportGeometry() [1/2]

virtual void OdGsViewImpl::invalidateCachedViewportGeometry ( )
virtual

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

Implements OdGsView.

◆ invalidateCachedViewportGeometry() [2/2]

void OdGsViewImpl::invalidateCachedViewportGeometry ( OdUInt32  mask)
Parameters
mask[in] Mask.

◆ invalidateRegion()

void OdGsViewImpl::invalidateRegion ( const OdGiPathNode path)

◆ invalidRects()

OdGsDCRectArray OdGsViewImpl::invalidRects ( OdGsOverlayId  nOverlay = kGsMainOverlay) const

◆ isAccumulateVpChanges()

bool OdGsViewImpl::isAccumulateVpChanges ( ) const
inline

Definition at line 963 of file GsViewImpl.h.

◆ isBackClipped()

virtual bool OdGsViewImpl::isBackClipped ( ) const
virtual

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

Implements OdGsView.

◆ isCheckValid()

bool OdGsViewImpl::isCheckValid ( ) const
inlineprotected

Definition at line 862 of file GsViewImpl.h.

◆ isCompletelyVisible()

bool OdGsViewImpl::isCompletelyVisible ( ) const
inline

Definition at line 968 of file GsViewImpl.h.

◆ isCullingVolumeInitialized()

virtual bool OdGsViewImpl::isCullingVolumeInitialized ( ) const
virtual

Returns true if and only if culling volume associated with current view.

Remarks
Culling volume consider associated with current view if pointer to culling volume is not null.
See also
initCullingVolume setCullingVolume cullingVolume

◆ isDependentGeometryView()

bool OdGsViewImpl::isDependentGeometryView ( ) const
inline

Definition at line 831 of file GsViewImpl.h.

◆ isDependentViewportView()

bool OdGsViewImpl::isDependentViewportView ( ) const
inline

Definition at line 826 of file GsViewImpl.h.

◆ isFrontClipped()

virtual bool OdGsViewImpl::isFrontClipped ( ) const
virtual

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

Implements OdGsView.

◆ isHelperView()

bool OdGsViewImpl::isHelperView ( ) const
inline

Definition at line 836 of file GsViewImpl.h.

◆ isInInteractivity()

virtual bool OdGsViewImpl::isInInteractivity ( ) const
virtual

Checks is this Viewport object is in interactive state.

Implements OdGsView.

◆ isInvalid()

bool OdGsViewImpl::isInvalid ( ) const
inlineprotected

Definition at line 872 of file GsViewImpl.h.

◆ isLayerVisible()

bool OdGsViewImpl::isLayerVisible ( OdDbStub *  layerId) const

◆ isLegacyHiddenMode()

virtual bool OdGsViewImpl::isLegacyHiddenMode ( ) const
virtual

◆ isLegacyWireframeMode()

virtual bool OdGsViewImpl::isLegacyWireframeMode ( ) const
virtual

◆ isNonRectClipped()

bool OdGsViewImpl::isNonRectClipped ( ) const
inline

Definition at line 897 of file GsViewImpl.h.

◆ isPerspective()

virtual bool OdGsViewImpl::isPerspective ( ) const
virtual

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

Implements OdGsView.

◆ isPlotTransparency()

virtual bool OdGsViewImpl::isPlotTransparency ( ) const
virtual

◆ isRegenOnDrawForbidden()

bool OdGsViewImpl::isRegenOnDrawForbidden ( ) const
inline

Definition at line 953 of file GsViewImpl.h.

◆ isRotated()

bool OdGsViewImpl::isRotated ( ) const
inline

Definition at line 902 of file GsViewImpl.h.

◆ isSnapping()

bool OdGsViewImpl::isSnapping ( ) const
inline

Definition at line 943 of file GsViewImpl.h.

◆ isStereoEnabled()

virtual bool OdGsViewImpl::isStereoEnabled ( ) const
virtual

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

Implements OdGsView.

◆ isSupportLegacyHiddenMode()

virtual bool OdGsViewImpl::isSupportLegacyHiddenMode ( ) const
virtual

◆ isSupportLegacyWireframeMode()

virtual bool OdGsViewImpl::isSupportLegacyWireframeMode ( ) const
virtual

◆ isSupportPlotStyles()

bool OdGsViewImpl::isSupportPlotStyles ( ) const
inline

Definition at line 857 of file GsViewImpl.h.

◆ isValid()

virtual bool OdGsViewImpl::isValid ( ) const
virtual

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.

◆ isValidViewportId()

bool OdGsViewImpl::isValidViewportId ( const OdUInt32  vpId) const

◆ isViewportBorderVisible()

virtual bool OdGsViewImpl::isViewportBorderVisible ( ) const
virtual

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

Implements OdGsView.

◆ isViewportOnScreen()

bool OdGsViewImpl::isViewportOnScreen ( ) const

Returns true if and only if this view object is not off-screen.

◆ isViewRegenerated()

virtual bool OdGsViewImpl::isViewRegenerated ( ) const
virtual

◆ isVisible()

virtual bool OdGsViewImpl::isVisible ( )
virtual

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

Implements OdGsView.

◆ lensLength()

virtual double OdGsViewImpl::lensLength ( ) const
virtual

Returns the perspective lens length for this Viewport object.

Implements OdGsView.

◆ lensLengthFromFOV()

static double OdGsViewImpl::lensLengthFromFOV ( double  fovAngle)
static

Utility function to recompute field of view angle into lens length.

Parameters
fovAngle[in] Field of view angle in radians.
Returns
Returns lens length in millimeters.
Remarks
Input angle must be in range between 4 and 179 degrees inclusively.

◆ lensLengthToFOV()

static double OdGsViewImpl::lensLengthToFOV ( double  lensLength)
static

Utility function to recompute lens length into field of view angle.

Parameters
lensLength[in] Lens length in millimeters.
Returns
Returns field of view angle in radians.

◆ linetypeAlternateScaleMultiplier()

double OdGsViewImpl::linetypeAlternateScaleMultiplier ( ) const
virtual

Returns current alternate linetype scale multiplier value.

Implements OdGsView.

◆ linetypeScaleMultiplier()

virtual double OdGsViewImpl::linetypeScaleMultiplier ( ) const
virtual

Returns current linetype scale multiplier value.

Implements OdGsView.

◆ lineweightToDcScale()

virtual double OdGsViewImpl::lineweightToDcScale ( ) const
virtual

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

Implements OdGsView.

◆ lineweightToPixels() [1/2]

double OdGsViewImpl::lineweightToPixels ( double  lineweight) const

Returns the number of pixels corresponding to the specified lineweight for this view object.

Parameters
lineweight[in] Lineweight.

◆ lineweightToPixels() [2/2]

int OdGsViewImpl::lineweightToPixels ( OdDb::LineWeight  lineweight) const

Returns the number of pixels corresponding to the specified lineweight for this view object.

Parameters
lineweight[in] Lineweight.

◆ loadClientViewState()

virtual bool OdGsViewImpl::loadClientViewState ( OdGsFiler pFiler)
virtual

◆ loadViewState()

virtual bool OdGsViewImpl::loadViewState ( OdGsFiler pFiler)
virtual

◆ mode()

virtual RenderMode OdGsViewImpl::mode ( ) const
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.

Implements OdGsView.

◆ objectToDeviceMatrix() [1/2]

virtual OdGeMatrix3d OdGsViewImpl::objectToDeviceMatrix ( ) const
virtual

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

See also
Coordinate Systems.

Implements OdGsView.

Reimplemented in OdGsBaseVectorizeViewJoin< BaseVectorizerObject >, OdGsBaseVectorizeViewJoin< OdGsBaseVectorizer >, and OdGsBaseVectorizeViewJoin< OdGsBaseMaterialViewPC >.

◆ objectToDeviceMatrix() [2/2]

OdGeMatrix3d OdGsViewImpl::objectToDeviceMatrix ( OdGsOverlayId  nOverlay) const

◆ ODRX_DECLARE_MEMBERS()

OdGsViewImpl::ODRX_DECLARE_MEMBERS ( OdGsViewImpl  )

◆ onFinalRelease()

void OdGsViewImpl::onFinalRelease ( )
protected

Notification function called whenever this ViewImpl object is about to be released.

◆ onWorldToEyeChanged()

void OdGsViewImpl::onWorldToEyeChanged ( )
protected

Notification function called whenever the World to Eye transformation matrix has been changed.

◆ orbit()

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

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.

◆ pan()

virtual void OdGsViewImpl::pan ( double  xPan,
double  yPan 
)
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.

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.

◆ partialUpdateExtentsEnlargement()

virtual int OdGsViewImpl::partialUpdateExtentsEnlargement ( ) const
virtual

Returns partial update rectange extension in pixels.

Remarks
This extension required for devices which support visual styles to avoid artifacts caused by silhouettes or line extensions.

◆ perspectiveMatrix()

OdGeMatrix3d OdGsViewImpl::perspectiveMatrix ( ) const

Returns the perspective transformation matrix for this view object.

◆ pointInView()

virtual bool OdGsViewImpl::pointInView ( const OdGePoint3d pt) const
virtual

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

Parameters
pt[in] WCS point for check.

Implements OdGsView.

◆ pointInViewport()

virtual bool OdGsViewImpl::pointInViewport ( const OdGePoint2d screenPoint) const
virtual

Checks does specified point is inside viewport area.

Parameters
screenPoint[in] Check point in device coordinate space.

Implements OdGsView.

◆ position()

virtual OdGePoint3d OdGsViewImpl::position ( ) const
virtual

Returns the WCS camera position for this Viewport object.

Implements OdGsView.

◆ projectionMatrix() [1/2]

virtual OdGeMatrix3d OdGsViewImpl::projectionMatrix ( ) const
virtual

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

See also
Coordinate Systems.

Implements OdGsView.

◆ projectionMatrix() [2/2]

OdGeMatrix3d OdGsViewImpl::projectionMatrix ( OdUInt32  nIncludes,
OdGsOverlayId  nOverlay = kGsMainOverlay 
) const

◆ propagateInvalidVpFlag()

virtual void OdGsViewImpl::propagateInvalidVpFlag ( )
protectedvirtual

◆ propagateLayersChanges()

virtual void OdGsViewImpl::propagateLayersChanges ( )
protectedvirtual

◆ registerOverlay()

void OdGsViewImpl::registerOverlay ( const OdGsModel pModel)

◆ roll()

virtual void OdGsViewImpl::roll ( double  rollAngle)
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 postiton to the target. The X-axis is the cross product Y-axis × Z-axis.

All angles are expressed in radians.

Implements OdGsView.

◆ rotationMatrix()

const OdGeMatrix3d& OdGsViewImpl::rotationMatrix ( ) const

◆ safeCast() [1/2]

const OdGsViewImpl * OdGsViewImpl::safeCast ( const OdGsView pView)
inlinestatic

Definition at line 938 of file GsViewImpl.h.

◆ safeCast() [2/2]

OdGsViewImpl * OdGsViewImpl::safeCast ( OdGsView pView)
inlinestatic

Returns the specified OdGsView pointer as a pointer to an OdGsViewImpl object.

Parameters
pView[in] Pointer to an OdGsView object.

Definition at line 933 of file GsViewImpl.h.

◆ saveClientViewState()

virtual bool OdGsViewImpl::saveClientViewState ( OdGsFiler pFiler) const
virtual

◆ saveViewState()

virtual bool OdGsViewImpl::saveViewState ( OdGsFiler pFiler) const
virtual

◆ sceneDept() [1/2]

virtual bool OdGsViewImpl::sceneDept ( double &  zNear,
double &  zFar 
) const
protectedvirtual

Reimplemented in OdGsBaseVectorizeView.

◆ sceneDept() [2/2]

virtual bool OdGsViewImpl::sceneDept ( double &  zNear,
double &  zFar,
OdGsOverlayId  nOverlay 
) const
protectedvirtual

Returns the minimum and maximum z-values for this view object.

Parameters
zNear[out] Receives the minimum z-value.
zFar[out] Receives the maximum z-value.
nOverlay[in] Overlay buffer index.
Returns
Returns true if and only if this view object has z-values associated with it.

Reimplemented in OdGsBaseVectorizeView.

◆ screenMatrix()

virtual OdGeMatrix3d OdGsViewImpl::screenMatrix ( ) const
virtual

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

See also
Coordinate Systems.

Implements OdGsView.

◆ screenRect() [1/2]

void OdGsViewImpl::screenRect ( OdGePoint2d lowerLeft,
OdGePoint2d upperRight 
) const

Introduces a DCS rectangle into this vectorization context.

Parameters
lowerLeft[in] Lower-left corner.
upperRight[in] Upper-right corner.

◆ screenRect() [2/2]

void OdGsViewImpl::screenRect ( OdGsDCPoint lowerLeft,
OdGsDCPoint upperRight 
) const

Introduces a DCS rectangle into this vectorization context.

Parameters
lowerLeft[in] Lower-left corner.
upperRight[in] Upper-right corner.

◆ screenRectNorm()

void OdGsViewImpl::screenRectNorm ( OdGsDCRect normalizedRect) const

◆ select() [1/2]

virtual void OdGsViewImpl::select ( const OdGePoint2d aPtDc,
int  numPoints,
OdGsSelectionReactor pReactor,
SelectionMode  mode = kCrossing 
)
pure virtual

Implemented in OdGsBaseVectorizeView.

◆ select() [2/2]

virtual void OdGsViewImpl::select ( const OdGsDCPoint points,
int  numPoints,
OdGsSelectionReactor pReactor,
SelectionMode  mode = kCrossing 
)
virtual

Evokes the specified OdGsSelectionReactor object for the specified polygon in this VectorizeView object.

Parameters
points[in] Array of points.
numPoints[in] Number of points.
pReactor[in] Pointer to the reactor.

Implements OdGsView.

◆ setAlternateLinetypeScaleMultiplier()

virtual void OdGsViewImpl::setAlternateLinetypeScaleMultiplier ( double  linetypeAlternateScaleMultiplier)
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.

Implements OdGsView.

◆ setBackClip()

virtual void OdGsViewImpl::setBackClip ( double  backClip)
virtual

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

Parameters
backClip[in] Back clip distance.

Implements OdGsView.

◆ setBackground()

virtual void OdGsViewImpl::setBackground ( OdDbStub *  backgroundId)
virtual

Sets background object for this view.

Parameters
backgroundId[in] New background object ID.

Implements OdGsView.

◆ setCheckValid()

void OdGsViewImpl::setCheckValid ( bool  bValue) const
inlineprotected

Definition at line 867 of file GsViewImpl.h.

◆ setClearColor()

virtual void OdGsViewImpl::setClearColor ( ClearColor  color)
virtual

Sets the clear color for this view

Parameters
color[in] The clear color.

Implements OdGsView.

◆ setCompletelyVisible()

void OdGsViewImpl::setCompletelyVisible ( bool  val)
inline

Definition at line 973 of file GsViewImpl.h.

◆ setContextualColors()

void OdGsViewImpl::setContextualColors ( OdGiContextualColors pColors)
inline

Definition at line 851 of file GsViewImpl.h.

◆ setCullingVolume()

void OdGsViewImpl::setCullingVolume ( OdGsCullingVolumePtr  newVol)

Sets culling volume associated with current view.

Parameters
newVol[in] Smart pointer to new culling volume object.
See also
cullingVolume initCullingVolume

◆ setEnableBackClip()

virtual void OdGsViewImpl::setEnableBackClip ( bool  enable)
virtual

Controls the back clipping of this Viewport object.

Parameters
enable[in] Enable back clipping.

Implements OdGsView.

◆ setEnableFrontClip()

virtual void OdGsViewImpl::setEnableFrontClip ( bool  enable)
virtual

Controls the front clipping of this Viewport object.

Parameters
enable[in] Enable front clipping.

Implements OdGsView.

◆ setFrontClip()

virtual void OdGsViewImpl::setFrontClip ( double  frontClip)
virtual

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

Parameters
frontClip[in] Front clip distance.

Implements OdGsView.

◆ setInvalid()

void OdGsViewImpl::setInvalid ( bool  bValue) const
inlineprotected

Definition at line 877 of file GsViewImpl.h.

◆ setInversion()

void OdGsViewImpl::setInversion ( bool  invertedX,
bool  invertedY 
)

◆ setLegacyHiddenMode()

virtual void OdGsViewImpl::setLegacyHiddenMode ( bool  bSet)
virtual

◆ setLegacyWireframeMode()

virtual void OdGsViewImpl::setLegacyWireframeMode ( bool  bSet)
virtual

◆ setLensLength()

virtual void OdGsViewImpl::setLensLength ( double  lensLength)
virtual

Sets the perspective lens length for this Viewport object.

Parameters
lensLength[in] Perspective lens length.

Implements OdGsView.

◆ setLinetypeScaleMultiplier()

virtual void OdGsViewImpl::setLinetypeScaleMultiplier ( double  linetypeScaleMultiplier)
virtual

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

Parameters
linetypeScaleMultiplier[in] Linetype scale multiplier.

Implements OdGsView.

◆ setLineweightEnum()

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

Sets the lineweights for this Viewport object.

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

Implements OdGsView.

◆ setLineweightToDcScale()

virtual void OdGsViewImpl::setLineweightToDcScale ( double  scale)
virtual

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

Parameters
scale[in] Scale factor.

Implements OdGsView.

◆ setMode()

virtual void OdGsViewImpl::setMode ( RenderMode  mode)
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.

Implements OdGsView.

◆ setModeOverride()

bool OdGsViewImpl::setModeOverride ( RenderMode  mode)

◆ setPerspectiveEnabled()

void OdGsViewImpl::setPerspectiveEnabled ( bool  bValue) const
inlineprotected

Definition at line 882 of file GsViewImpl.h.

◆ setPlotTransparency()

virtual void OdGsViewImpl::setPlotTransparency ( bool  bSet)
virtual

◆ setRegenOnDrawForbidden()

void OdGsViewImpl::setRegenOnDrawForbidden ( bool  val)
inline

Definition at line 958 of file GsViewImpl.h.

◆ setSnapping()

void OdGsViewImpl::setSnapping ( bool  val)
inline

Definition at line 948 of file GsViewImpl.h.

◆ setStereoParameters()

virtual void OdGsViewImpl::setStereoParameters ( double  magnitude,
double  parallax 
)
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.

Implements OdGsView.

◆ setView()

virtual void OdGsViewImpl::setView ( const OdGePoint3d position,
const OdGePoint3d target,
const OdGeVector3d upVector,
double  fieldWidth,
double  fieldHeight,
Projection  projectionType = kParallel 
)
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
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.

◆ setViewport() [1/3]

virtual void OdGsViewImpl::setViewport ( const OdGePoint2d lowerLeft,
const OdGePoint2d upperRight 
)
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].
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.

◆ setViewport() [2/3]

virtual void OdGsViewImpl::setViewport ( const OdGsDCRect screenRect)
virtual

Implements OdGsView.

◆ setViewport() [3/3]

virtual void OdGsViewImpl::setViewport ( const OdGsDCRectDouble screenRec)
virtual

Reimplemented from OdGsView.

◆ setViewport3dClipping()

virtual void OdGsViewImpl::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 from OdGsView.

◆ setViewportBorderProperties()

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

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.

◆ setViewportBorderVisibility()

virtual void OdGsViewImpl::setViewportBorderVisibility ( bool  visible)
virtual

Controls the border visibility for this Viewport object.

Parameters
visible[in] Controls visibility.

Implements OdGsView.

◆ setViewportClipRegion() [1/2]

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

Implements OdGsView.

◆ setViewportClipRegion() [2/2]

virtual void OdGsViewImpl::setViewportClipRegion ( int  numContours,
int const *  numVertices,
OdGsDCPoint const *  vertices 
)
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.

Implements OdGsView.

◆ setVisualStyle() [1/2]

virtual void OdGsViewImpl::setVisualStyle ( const OdGiVisualStyle visualStyle)
virtual

Sets visual style for this view.

Parameters
visualStyle[in] New visual style data.

Implements OdGsView.

Reimplemented in OdGsBaseVectorizeViewJoin< BaseVectorizerObject >, OdGsBaseVectorizeViewJoin< OdGsBaseVectorizer >, and OdGsBaseVectorizeViewJoin< OdGsBaseMaterialViewPC >.

◆ setVisualStyle() [2/2]

virtual void OdGsViewImpl::setVisualStyle ( OdDbStub *  visualStyleId)
virtual

Sets visual style object for this view.

Parameters
visualStyleId[in] New visual style object ID.

Implements OdGsView.

◆ show()

virtual void OdGsViewImpl::show ( )
virtual

Un-hides this Viewport object.

Implements OdGsView.

◆ target()

virtual OdGePoint3d OdGsViewImpl::target ( ) const
virtual

Returns the WCS camera target for this Viewport object.

Implements OdGsView.

◆ thawLayer()

virtual void OdGsViewImpl::thawLayer ( OdDbStub *  layerID)
virtual

Thaws the specified Layer object in this Viewport object.

Parameters
layerID[in] Layer to thaw.
Remarks
All layers are thawed by default.

Implements OdGsView.

◆ unregisterOverlay()

void OdGsViewImpl::unregisterOverlay ( const OdGsModel pModel)

◆ unrotatedFieldHeight()

double OdGsViewImpl::unrotatedFieldHeight ( ) const

When viewport is not rotated (or rotated 180)

+--------------—* m_dcScreenMax | | | | | | fieldHeight | | unrotatedFieldHeight | | |m_dcScreenMin | --------------—+ fieldWidth unrotatedFieldWidth

When viewport is rotated to 90 or 270:

m_dcScreenMin --------------—+ | | | | | | fieldHeight | | unrotatedFieldWidth | | | | +--------------—* m_dcScreenMax fieldWidth unrotatedFieldHeight

Returns fieldWidth and fieldHeight

◆ unrotatedFieldWidth()

double OdGsViewImpl::unrotatedFieldWidth ( ) const

◆ updateViewportProperties()

bool OdGsViewImpl::updateViewportProperties ( OdUInt32  incFlags)

◆ updateViewProps()

virtual void OdGsViewImpl::updateViewProps ( bool  bFullUpdate = true)
protectedvirtual

◆ upVector()

virtual OdGeVector3d OdGsViewImpl::upVector ( ) const
virtual

Returns the WCS camera up vector for this Viewport object.

Implements OdGsView.

◆ usesDept()

virtual bool OdGsViewImpl::usesDept ( double *  pMinDeptSupported = 0,
double *  pMaxDeptSupported = 0 
) const
protectedvirtual

Returns the minimum and maximum depth of this view object.

Parameters
pMinDeptSupported[out] Receives the minimum depth supported.
pMaxDeptSupported[out] Receives the maximum depth supported.
Returns
Returns true if and only if this view object supports depth.
Remarks
The default implementation of this function does nothing but return false.

◆ viewExtents()

virtual bool OdGsViewImpl::viewExtents ( OdGeBoundBlock3d extents) const
pure virtual

Returns the eye coordinate system extents of this view object.

Parameters
extents[out] Receives the extents.
Returns
Returns true if and only if the extents are defined.

Implemented in OdGsBaseVectorizeView.

◆ viewingMatrix()

virtual OdGeMatrix3d OdGsViewImpl::viewingMatrix ( ) const
virtual

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

See also
Coordinate Systems.

Implements OdGsView.

◆ viewParameters()

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

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

Parameters
pView[out] Receives the view parameters.

Implements OdGsView.

◆ viewport3dClipping()

virtual const OdGiClipBoundary* OdGsViewImpl::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.

Reimplemented from OdGsView.

◆ viewport3dClippingObject()

OdGiClipBoundaryWithAbstractData * OdGsViewImpl::viewport3dClippingObject ( )
inline

Returns the current 3d clipping for this Viewport object as single object.

Definition at line 978 of file GsViewImpl.h.

◆ viewportClipRegion() [1/2]

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

Implements OdGsView.

◆ viewportClipRegion() [2/2]

virtual void OdGsViewImpl::viewportClipRegion ( OdIntArray counts,
OdGsDCPointArray vertices 
) const
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.

Implements OdGsView.

◆ viewportDcCorners()

void OdGsViewImpl::viewportDcCorners ( OdGePoint2d lower_left,
OdGePoint2d upper_right 
) const

◆ viewportId()

OdUInt32 OdGsViewImpl::viewportId ( ) const
inline

Definition at line 240 of file GsViewImpl.h.

◆ viewportRotation()

short OdGsViewImpl::viewportRotation ( ) const

◆ visualStyle() [1/2]

virtual OdDbStub* OdGsViewImpl::visualStyle ( ) const
virtual

Returns current visual style object ID for this view.

Implements OdGsView.

◆ visualStyle() [2/2]

virtual bool OdGsViewImpl::visualStyle ( OdGiVisualStyle visualStyle) const
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.

Implements OdGsView.

◆ windowAspect()

double OdGsViewImpl::windowAspect ( ) const

Returns the width to height ratio for this view object.

◆ worldToDeviceMatrix() [1/2]

virtual OdGeMatrix3d OdGsViewImpl::worldToDeviceMatrix ( ) const
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.

Implements OdGsView.

◆ worldToDeviceMatrix() [2/2]

OdGeMatrix3d OdGsViewImpl::worldToDeviceMatrix ( OdGsOverlayId  nOverlay) const

◆ worldToEyeMatrix()

const OdGeMatrix3d & OdGsViewImpl::worldToEyeMatrix ( ) const
inline

Definition at line 923 of file GsViewImpl.h.

◆ xVector()

const OdGeVector3d& OdGsViewImpl::xVector ( ) const
inline

Definition at line 396 of file GsViewImpl.h.

◆ zoom()

virtual void OdGsViewImpl::zoom ( double  zoomFactor)
virtual

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

Parameters
zoomFactor[in] Zoom factor.

Implements OdGsView.

◆ zoomExtents()

virtual void OdGsViewImpl::zoomExtents ( const OdGePoint3d minPt,
const OdGePoint3d maxPt 
)
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.

Implements OdGsView.

◆ zoomWindow()

virtual void OdGsViewImpl::zoomWindow ( const OdGePoint2d lowerLeft,
const OdGePoint2d upperRight 
)
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].

Implements OdGsView.

Friends And Related Function Documentation

◆ GsViewImplHelper

friend class GsViewImplHelper
friend

Definition at line 819 of file GsViewImpl.h.

◆ OdGiBaseVectorizerImpl

friend class OdGiBaseVectorizerImpl
friend

Definition at line 820 of file GsViewImpl.h.

◆ OdGsBaseModule

friend class OdGsBaseModule
friend

Definition at line 822 of file GsViewImpl.h.

◆ OdGsBaseVectorizeDevice

friend class OdGsBaseVectorizeDevice
friend

Definition at line 823 of file GsViewImpl.h.

◆ OdGsBaseVectorizer

friend class OdGsBaseVectorizer
friend

Definition at line 821 of file GsViewImpl.h.

Member Data Documentation

◆ m_backClipDist

double OdGsViewImpl::m_backClipDist
protected

Definition at line 737 of file GsViewImpl.h.

◆ m_bInInteractivityMode

bool OdGsViewImpl::m_bInInteractivityMode
protected

Definition at line 816 of file GsViewImpl.h.

◆ m_borderColor

ODCOLORREF OdGsViewImpl::m_borderColor
protected

Definition at line 734 of file GsViewImpl.h.

◆ m_borderWeight

int OdGsViewImpl::m_borderWeight
protected

Definition at line 735 of file GsViewImpl.h.

◆ m_dcLowerLeft

OdGePoint2d OdGsViewImpl::m_dcLowerLeft
protected

Definition at line 742 of file GsViewImpl.h.

◆ m_dcScreenMax

OdGePoint2d OdGsViewImpl::m_dcScreenMax
protected

Definition at line 741 of file GsViewImpl.h.

◆ m_dcScreenMin

OdGePoint2d OdGsViewImpl::m_dcScreenMin
protected

Definition at line 740 of file GsViewImpl.h.

◆ m_dcUpperRight

OdGePoint2d OdGsViewImpl::m_dcUpperRight
protected

Definition at line 743 of file GsViewImpl.h.

◆ m_defaultLightingType

DefaultLightingType OdGsViewImpl::m_defaultLightingType
protected

Definition at line 776 of file GsViewImpl.h.

◆ m_deviation

double OdGsViewImpl::m_deviation[5]
protected

Definition at line 767 of file GsViewImpl.h.

◆ m_dInteractivityFrameRate

double OdGsViewImpl::m_dInteractivityFrameRate
protected

Definition at line 817 of file GsViewImpl.h.

◆ m_drawables

DrawableHolderArray OdGsViewImpl::m_drawables
protected

Definition at line 812 of file GsViewImpl.h.

◆ m_eyeToWorld

OdGeMatrix3d OdGsViewImpl::m_eyeToWorld
mutableprotected

Definition at line 755 of file GsViewImpl.h.

◆ m_eyeVecLength

double OdGsViewImpl::m_eyeVecLength
protected

Definition at line 748 of file GsViewImpl.h.

◆ m_eyeVector

OdGeVector3d OdGsViewImpl::m_eyeVector
protected

Definition at line 753 of file GsViewImpl.h.

◆ m_fieldHeight

double OdGsViewImpl::m_fieldHeight
protected

Definition at line 746 of file GsViewImpl.h.

◆ m_fieldWidth

double OdGsViewImpl::m_fieldWidth
protected

Definition at line 745 of file GsViewImpl.h.

◆ m_frontClipDist

double OdGsViewImpl::m_frontClipDist
protected

Definition at line 736 of file GsViewImpl.h.

◆ m_frozenLayers

OdDbStubPtrArray OdGsViewImpl::m_frozenLayers
protected

Definition at line 814 of file GsViewImpl.h.

◆ m_frozenLayersDiff

OdDbStubPtrArray OdGsViewImpl::m_frozenLayersDiff
protected

Definition at line 731 of file GsViewImpl.h.

◆ m_giViewportId

OdUInt32 OdGsViewImpl::m_giViewportId
protected

Definition at line 801 of file GsViewImpl.h.

◆ m_gsViewImplFlags

OdUInt32 OdGsViewImpl::m_gsViewImplFlags
mutableprotected

Definition at line 733 of file GsViewImpl.h.

◆ m_lastFrozenLayers

OdDbStubPtrArray OdGsViewImpl::m_lastFrozenLayers
protected

Definition at line 730 of file GsViewImpl.h.

◆ m_lensLength

double OdGsViewImpl::m_lensLength
protected

Definition at line 747 of file GsViewImpl.h.

◆ m_linetypeAlternateScaleMultiplier

double OdGsViewImpl::m_linetypeAlternateScaleMultiplier
protected

Definition at line 761 of file GsViewImpl.h.

◆ m_linetypeScaleMultiplier

double OdGsViewImpl::m_linetypeScaleMultiplier
protected

Definition at line 760 of file GsViewImpl.h.

◆ m_lineweightToDcScale

double OdGsViewImpl::m_lineweightToDcScale
protected

Definition at line 762 of file GsViewImpl.h.

◆ m_lweights

OdUInt8Array OdGsViewImpl::m_lweights
protected

Definition at line 763 of file GsViewImpl.h.

◆ m_mtExtents

OdMutex OdGsViewImpl::m_mtExtents
mutableprotected

Definition at line 770 of file GsViewImpl.h.

◆ m_nCachedDrawables

int OdGsViewImpl::m_nCachedDrawables
protected

Definition at line 769 of file GsViewImpl.h.

◆ m_nrcCounts

OdIntArray OdGsViewImpl::m_nrcCounts
protected

Definition at line 758 of file GsViewImpl.h.

◆ m_nrcPoints

OdGePoint2dArray OdGsViewImpl::m_nrcPoints
protected

Definition at line 759 of file GsViewImpl.h.

◆ m_overlayData

GsViewOverlayDataContainer OdGsViewImpl::m_overlayData
protected

Definition at line 797 of file GsViewImpl.h.

◆ m_p3dClip

OdSharedPtr<OdGiClipBoundaryWithAbstractData> OdGsViewImpl::m_p3dClip
protected

Definition at line 765 of file GsViewImpl.h.

◆ m_pBackgroundId

OdDbStub* OdGsViewImpl::m_pBackgroundId
protected

Definition at line 773 of file GsViewImpl.h.

◆ m_pCullingVolume

OdGsCullingVolumePtr OdGsViewImpl::m_pCullingVolume
protected

Definition at line 764 of file GsViewImpl.h.

◆ m_pDevice

OdGsBaseVectorizeDevice* OdGsViewImpl::m_pDevice
protected

Definition at line 799 of file GsViewImpl.h.

◆ m_pGsReserved

OdRxObjectPtr OdGsViewImpl::m_pGsReserved
protected

Definition at line 807 of file GsViewImpl.h.

◆ m_pModule

OdGsBaseModulePtr OdGsViewImpl::m_pModule
protected

Definition at line 729 of file GsViewImpl.h.

◆ m_position

OdGePoint3d OdGsViewImpl::m_position
protected

Definition at line 750 of file GsViewImpl.h.

◆ m_pProperties

OdGsPropertiesPtr OdGsViewImpl::m_pProperties
protected

Definition at line 772 of file GsViewImpl.h.

◆ m_pViewportTrans

OdGiDrawablePtr OdGsViewImpl::m_pViewportTrans
protected

Definition at line 775 of file GsViewImpl.h.

◆ m_pVisualStyleId

OdDbStub* OdGsViewImpl::m_pVisualStyleId
protected

Definition at line 774 of file GsViewImpl.h.

◆ m_regenerationType

OdGiRegenType OdGsViewImpl::m_regenerationType
protected

Definition at line 805 of file GsViewImpl.h.

◆ m_renderMode

RenderMode OdGsViewImpl::m_renderMode
protected

Definition at line 810 of file GsViewImpl.h.

◆ m_screenInvertedX

bool OdGsViewImpl::m_screenInvertedX
protected

Definition at line 738 of file GsViewImpl.h.

◆ m_screenInvertedY

bool OdGsViewImpl::m_screenInvertedY
protected

Definition at line 739 of file GsViewImpl.h.

◆ m_target

OdGePoint3d OdGsViewImpl::m_target
protected

Definition at line 751 of file GsViewImpl.h.

◆ m_upVector

OdGeVector3d OdGsViewImpl::m_upVector
protected

Definition at line 752 of file GsViewImpl.h.

◆ m_viewInfo

OdGsClientViewInfo OdGsViewImpl::m_viewInfo
protected

Definition at line 800 of file GsViewImpl.h.

◆ m_worldToEye

OdGeMatrix3d OdGsViewImpl::m_worldToEye
mutableprotected

Definition at line 756 of file GsViewImpl.h.

◆ m_xVector

OdGeVector3d OdGsViewImpl::m_xVector
protected

Definition at line 754 of file GsViewImpl.h.


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