CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdGsViewWrapper< GsViewInterface, RedirectionBase > Class Template Reference

#include <GsInterfaceWrappers.h>

Inheritance diagram for OdGsViewWrapper< GsViewInterface, RedirectionBase >:
OdGsDefaultRedirectionBase< RedirectionBaseInterface, RedirectionInterface > OdGsViewWrapperMinimalImpl< GsViewInterface, RedirectionBase >

Public Member Functions

 OdGsViewWrapper (OdGsView *pRedirectionView=NULL)
 
OdGsDevicedevice () const
 
OdGiContextuserGiContext () const
 
void setUserGiContext (OdGiContext *pUserGiContext)
 
double lineweightToDcScale () const
 
void setLineweightToDcScale (double scale)
 
void setLineweightEnum (int numLineweights, const OdUInt8 *lineweights)
 
void setViewport (const OdGePoint2d &lowerLeft, const OdGePoint2d &upperRight)
 
void setViewport (const OdGsDCRect &screenRect)
 
void setViewport (const OdGsDCRectDouble &screenRect)
 
void getViewport (OdGePoint2d &lowerLeft, OdGePoint2d &upperRight) const
 
void getViewport (OdGsDCRect &screenRect) const
 
void getViewport (OdGsDCRectDouble &screenRect) const
 
void setViewportClipRegion (int numContours, int const *numVertices, OdGsDCPoint const *vertices)
 
void setViewportClipRegion (int numContours, int const *numVertices, OdGePoint2d const *vertices)
 
void viewportClipRegion (OdIntArray &counts, OdGsDCPointArray &vertices) const
 
void viewportClipRegion (OdIntArray &counts, OdGePoint2dArray &vertices) const
 
void setViewport3dClipping (const OdGiClipBoundary *pBoundary, const OdGiAbstractClipBoundary *pClipInfo=NULL)
 
const OdGiClipBoundaryviewport3dClipping (const OdGiAbstractClipBoundary **ppClipInfo=NULL) const
 
void setViewportBorderProperties (ODCOLORREF color, int width)
 
void getViewportBorderProperties (ODCOLORREF &color, int &width) const
 
void setViewportBorderVisibility (bool visible)
 
bool isViewportBorderVisible () const
 
void setView (const OdGePoint3d &position, const OdGePoint3d &target, const OdGeVector3d &upVector, double fieldWidth, double fieldHeight, OdGsView::Projection projectionType=OdGsView::kParallel)
 
OdGePoint3d position () const
 
OdGePoint3d target () const
 
OdGeVector3d upVector () const
 
double lensLength () const
 
void setLensLength (double lensLength)
 
bool isPerspective () const
 
double fieldWidth () const
 
double fieldHeight () const
 
void setEnableFrontClip (bool enable)
 
bool isFrontClipped () const
 
void setFrontClip (double frontClip)
 
double frontClip () const
 
void setEnableBackClip (bool enable)
 
bool isBackClipped () const
 
void setBackClip (double backClip)
 
double backClip () const
 
OdGeMatrix3d viewingMatrix () const
 
OdGeMatrix3d projectionMatrix () const
 
OdGeMatrix3d screenMatrix () const
 
OdGeMatrix3d worldToDeviceMatrix () const
 
OdGeMatrix3d objectToDeviceMatrix () const
 
void setMode (OdGsView::RenderMode mode)
 
OdGsView::RenderMode mode () const
 
bool add (OdGiDrawable *pSceneGraph, OdGsModel *pModel)
 
int numRootDrawables () const
 
OdDbStub * rootDrawableIdAt (int i, OdGsModelPtr *pModelReturn) const
 
OdGiDrawablePtr rootDrawableAt (int i, OdGsModelPtr *pModelReturn) const
 
bool erase (OdGiDrawable *sceneGraph)
 
void eraseAll ()
 
OdGsModelgetModel (const OdGiDrawable *pDrawable) const
 
OdGsModelArray getModelList () const
 
void invalidate ()
 
void invalidate (const OdGsDCRect &screenRect)
 
bool isValid () const
 
void update ()
 
void beginInteractivity (double frameRateInHz)
 
void endInteractivity ()
 
bool isInInteractivity () const
 
double interactivityFrameRate () const
 
void flush ()
 
void hide ()
 
void show ()
 
bool isVisible ()
 
void freezeLayer (OdDbStub *layerID)
 
void thawLayer (OdDbStub *layerID)
 
void clearFrozenLayers ()
 
void invalidateCachedViewportGeometry ()
 
void select (const OdGsDCPoint *pts, int nPoints, OdGsSelectionReactor *pReactor, OdGsView::SelectionMode mode=OdGsView::kCrossing)
 
void dolly (const OdGeVector3d &dollyVector)
 
void dolly (double xDolly, double yDolly, double zDolly)
 
void roll (double rollAngle)
 
void orbit (double xOrbit, double yOrbit)
 
void zoom (double zoomFactor)
 
void pan (double xPan, double yPan)
 
void zoomExtents (const OdGePoint3d &minPt, const OdGePoint3d &maxPt)
 
void zoomWindow (const OdGePoint2d &lowerLeft, const OdGePoint2d &upperRight)
 
bool pointInView (const OdGePoint3d &pt) const
 
bool extentsInView (const OdGePoint3d &minPt, const OdGePoint3d &maxPt) const
 
OdGsViewPtr cloneView (bool cloneViewParameters=true, bool cloneGeometry=false)
 
void viewParameters (OdGsView *pView) const
 
bool exceededBounds ()
 
void enableStereo (bool enabled)
 
bool isStereoEnabled () const
 
void setStereoParameters (double magnitude, double parallax)
 
void getStereoParameters (double &magnitude, double &parallax) const
 
void initLights (OdRxIterator *pLightsIterator)
 
void setLinetypeScaleMultiplier (double linetypeScaleMultiplier)
 
double linetypeScaleMultiplier () const
 
void setAlternateLinetypeScaleMultiplier (double linetypeAlternateScaleMultiplier)
 
double linetypeAlternateScaleMultiplier () const
 
void clientViewInfo (OdGsClientViewInfo &clientViewInfo) const
 
void setClearColor (OdGsView::ClearColor color)
 
bool pointInViewport (const OdGePoint2d &screenPoint) const
 
void getNumPixelsInUnitSquare (const OdGePoint3d &point, OdGePoint2d &pixelDensity, bool bUsePerspective=true) const
 
void setBackground (OdDbStub *backgroundId)
 
OdDbStub * background () const
 
void setVisualStyle (OdDbStub *visualStyleId)
 
OdDbStub * visualStyle () const
 
void setVisualStyle (const OdGiVisualStyle &visualStyle)
 
bool visualStyle (OdGiVisualStyle &visualStyle) const
 
void enableDefaultLighting (bool bEnable, OdGsView::DefaultLightingType lightType=OdGsView::kTwoLights)
 
void getSnapShot (OdGiRasterImagePtr &pImage, const OdGsDCRect &region)
 
void collide (OdGiPathNode const *const *pInputList, OdUInt32 nInputListSize, OdGsCollisionDetectionReactor *pReactor, OdGiPathNode const *const *pCollisionWithList=NULL, OdUInt32 nCollisionWithListSize=0, const OdGsCollisionDetectionContext *pCtx=NULL)
 
void enableAntiAliasing (OdUInt32 nMode)
 
OdUInt32 antiAliasingMode () const
 
void enableSSAO (bool bEnable) ODRX_OVERRIDE
 
bool ssaoMode () const ODRX_OVERRIDE
 
- Public Member Functions inherited from OdGsDefaultRedirectionBase< RedirectionBaseInterface, RedirectionInterface >
 OdGsDefaultRedirectionBase (RedirectionBaseInterface *pRedirectionObj=NULL)
 
bool hasRedirection () const
 
const RedirectionBaseInterface * redirection () const
 
RedirectionBaseInterface * redirection ()
 
void setRedirection (RedirectionBaseInterface *pRedirectionObj)
 
void resetRedirection ()
 

Detailed Description

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

Base template for OdGsView class wrappers.

Corresponding C++ library: TD_Gs

<group OdGs_Classes>

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

Definition at line 151 of file GsInterfaceWrappers.h.

Constructor & Destructor Documentation

◆ OdGsViewWrapper()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGsViewWrapper< GsViewInterface, RedirectionBase >::OdGsViewWrapper ( OdGsView pRedirectionView = NULL)
inline

Constructor for the OdGsViewWrapper class. Sets the redirection view.

Parameters
pRedirectionView[in] Redirection view.

Definition at line 163 of file GsInterfaceWrappers.h.

Member Function Documentation

◆ add()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::add ( OdGiDrawable pSceneGraph,
OdGsModel pModel 
)
inline

Adds the specified scene graph to the wrapped 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.
Returns
false.
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 the wrapped viewport object.

Definition at line 783 of file GsInterfaceWrappers.h.

◆ antiAliasingMode()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdUInt32 OdGsViewWrapper< GsViewInterface, RedirectionBase >::antiAliasingMode ( ) const
inline

Returns anti-aliasing mode for current Viewport object.

Definition at line 1635 of file GsInterfaceWrappers.h.

◆ backClip()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
double OdGsViewWrapper< GsViewInterface, RedirectionBase >::backClip ( ) const
inline

Returns the back clip distance from the target of the wrapped viewport object. This method returns 0.0 if there is no redirection view.

Definition at line 649 of file GsInterfaceWrappers.h.

◆ background()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdDbStub * OdGsViewWrapper< GsViewInterface, RedirectionBase >::background ( ) const
inline

Returns current background object ID for the wrapped view. This method returns NULL if there is no redirection view.

See also
<link tv_working_with_attributes_view_backgrounds, Work with View Backgrounds>

Definition at line 1506 of file GsInterfaceWrappers.h.

◆ beginInteractivity()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::beginInteractivity ( double  frameRateInHz)
inline

Puts the wrapped 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>

Definition at line 935 of file GsInterfaceWrappers.h.

◆ clearFrozenLayers()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::clearFrozenLayers ( )
inline

Thaws all Layer objects in the wrapped viewport object.

Remarks
All layers are thawed by default.
See also
<link tv_working_with_attributes_layers, Work with Layers>

Definition at line 1059 of file GsInterfaceWrappers.h.

◆ clientViewInfo()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::clientViewInfo ( OdGsClientViewInfo clientViewInfo) const
inline

Returns the ClientViewInfo for the wrapped viewport object.

Parameters
clientViewInfo[out] Receives the ClientViewInfo.

Definition at line 1437 of file GsInterfaceWrappers.h.

◆ cloneView()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGsViewPtr OdGsViewWrapper< GsViewInterface, RedirectionBase >::cloneView ( bool  cloneViewParameters = true,
bool  cloneGeometry = false 
)
inline

Clones the wrapped view object and returns a smart pointer to it. This method returns NULL view smart pointer valid if there is no redirection view.

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
smart pointer to the newly created object.

Definition at line 1264 of file GsInterfaceWrappers.h.

◆ collide()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::collide ( OdGiPathNode const *const *  pInputList,
OdUInt32  nInputListSize,
OdGsCollisionDetectionReactor pReactor,
OdGiPathNode const *const *  pCollisionWithList = NULL,
OdUInt32  nCollisionWithListSize = 0,
const OdGsCollisionDetectionContext pCtx = NULL 
)
inline

Runs collision detection procedure inside the wrapped 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>

Definition at line 1613 of file GsInterfaceWrappers.h.

◆ device()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGsDevice * OdGsViewWrapper< GsViewInterface, RedirectionBase >::device ( ) const
inline

Retrieves a pointer to a device that owns the wrapped view. This method returns NULL if there is no redirection view.

Definition at line 173 of file GsInterfaceWrappers.h.

◆ dolly() [1/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::dolly ( const OdGeVector3d dollyVector)
inline

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

Definition at line 1101 of file GsInterfaceWrappers.h.

◆ dolly() [2/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::dolly ( double  xDolly,
double  yDolly,
double  zDolly 
)
inline

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

Definition at line 1119 of file GsInterfaceWrappers.h.

◆ enableAntiAliasing()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::enableAntiAliasing ( OdUInt32  nMode)
inline

Enables or disables anti-aliasing in current Viewport object.

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

Definition at line 1626 of file GsInterfaceWrappers.h.

◆ enableDefaultLighting()

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

Enables default lighting for the wrapped view.

Parameters
bEnable[in] New default lighting state.
lightType[in] New default lighting type.
See also
<link tv_working_with_lights, Work with Lights>

Definition at line 1578 of file GsInterfaceWrappers.h.

◆ enableSSAO()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::enableSSAO ( bool  bEnable)
inline

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.

Definition at line 1647 of file GsInterfaceWrappers.h.

◆ enableStereo()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::enableStereo ( bool  enabled)
inline

Controls stereo viewing for the wrapped viewport object.

Parameters
enable[in] Controls stereo viewing.

Definition at line 1311 of file GsInterfaceWrappers.h.

◆ endInteractivity()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::endInteractivity ( )
inline

Removes the wrapped viewport object from the interactive state.

Parameters
frameRateInHz[in] Frames/second.
See also
<link gs_views_interactivity_mode, Work with Interactivity Mode for Views>

Definition at line 947 of file GsInterfaceWrappers.h.

◆ erase()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::erase ( OdGiDrawable sceneGraph)
inline

Removes the specified scene graph from the wrapped viewport object.

Parameters
sceneGraph[in] Pointer to the root of the scene graph.
Returns
true if scene graph is successfully erased, false otherwise. This method returns false if there is no redirection view.

Definition at line 832 of file GsInterfaceWrappers.h.

◆ eraseAll()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::eraseAll ( )
inline

Removes all scene graphs from the wrapped viewport object.

Parameters
sceneGraph[in] Root of scene graph.

Definition at line 844 of file GsInterfaceWrappers.h.

◆ exceededBounds()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::exceededBounds ( )
inline

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. This method returns false if there is no redirection view.
Remarks
The following calls are monitored:

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

Definition at line 1299 of file GsInterfaceWrappers.h.

◆ extentsInView()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::extentsInView ( const OdGePoint3d minPt,
const OdGePoint3d maxPt 
) const
inline

Checks whether specified WCS box is visible completely or partially inside current view frustum. This method returns false if there is no redirection view.

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.

Definition at line 1248 of file GsInterfaceWrappers.h.

◆ fieldHeight()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
double OdGsViewWrapper< GsViewInterface, RedirectionBase >::fieldHeight ( ) const
inline

Returns the WCS projection plane (field) height for the wrapped viewport object. This method returns 1.0 if there is no redirection view.

Definition at line 561 of file GsInterfaceWrappers.h.

◆ fieldWidth()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
double OdGsViewWrapper< GsViewInterface, RedirectionBase >::fieldWidth ( ) const
inline

Returns the WCS projection plane (field) width for the wrapped viewport object. This method returns 1.0 if there is no redirection view.

Definition at line 550 of file GsInterfaceWrappers.h.

◆ flush()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::flush ( )
inline

Flushes the graphic pipeline and renders the wrapped viewport object.

Remarks
This function should be called only during interactivty.

Definition at line 987 of file GsInterfaceWrappers.h.

◆ freezeLayer()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::freezeLayer ( OdDbStub *  layerID)
inline

Freezes the specified Layer object in the wrapped 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>

Definition at line 1032 of file GsInterfaceWrappers.h.

◆ frontClip()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
double OdGsViewWrapper< GsViewInterface, RedirectionBase >::frontClip ( ) const
inline

Returns the front clip distance from the target of the wrapped viewport object. This method returns 0.0 if there is no redirection view.

Definition at line 605 of file GsInterfaceWrappers.h.

◆ getModel()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGsModel * OdGsViewWrapper< GsViewInterface, RedirectionBase >::getModel ( const OdGiDrawable pDrawable) const
inline

Returns OdGsModel object associated with specified OdGiDrawable object in the wrapped viewport object. This method returns NULL if there is no redirection view.

Parameters
pDrawable[in] Pointer onto OdGiDrawable object.

Definition at line 856 of file GsInterfaceWrappers.h.

◆ getModelList()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGsModelArray OdGsViewWrapper< GsViewInterface, RedirectionBase >::getModelList ( ) const
inline

Returns array of OdGsModel objects associated with the wrapped viewport object. This method returns an empty model array if there is no redirection view.

Definition at line 867 of file GsInterfaceWrappers.h.

◆ getNumPixelsInUnitSquare()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getNumPixelsInUnitSquare ( const OdGePoint3d point,
OdGePoint2d pixelDensity,
bool  bUsePerspective = true 
) const
inline

Returns the display pixel density at the specified point for the wrapped 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.

Definition at line 1480 of file GsInterfaceWrappers.h.

◆ getSnapShot()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getSnapShot ( OdGiRasterImagePtr pImage,
const OdGsDCRect region 
)
inline

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.

Definition at line 1592 of file GsInterfaceWrappers.h.

◆ getStereoParameters()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getStereoParameters ( double &  magnitude,
double &  parallax 
) const
inline

Returns the stereo parameters for the wrapped 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.

Definition at line 1366 of file GsInterfaceWrappers.h.

◆ getViewport() [1/3]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getViewport ( OdGePoint2d lowerLeft,
OdGePoint2d upperRight 
) const
inline

Returns the size and position of the wrapped 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.

Definition at line 295 of file GsInterfaceWrappers.h.

◆ getViewport() [2/3]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getViewport ( OdGsDCRect screenRect) const
inline

Returns the size and position of the wrapped 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.

Definition at line 311 of file GsInterfaceWrappers.h.

◆ getViewport() [3/3]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getViewport ( OdGsDCRectDouble screenRect) const
inline

Returns the size and position of the wrapped 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.

Definition at line 324 of file GsInterfaceWrappers.h.

◆ getViewportBorderProperties()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::getViewportBorderProperties ( ODCOLORREF color,
int &  width 
) const
inline

Returns the color and width of the border for the wrapped viewport object.

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

Definition at line 423 of file GsInterfaceWrappers.h.

◆ hide()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::hide ( )
inline

Hides the wrapped viewport object.

Definition at line 996 of file GsInterfaceWrappers.h.

◆ initLights()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::initLights ( OdRxIterator pLightsIterator)
inline

Returns an iterator to traverse the lights attached to the wrapped viewport object.

Parameters
pLightsIterator[in] Pointer to the lights iterator.

Definition at line 1376 of file GsInterfaceWrappers.h.

◆ interactivityFrameRate()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
double OdGsViewWrapper< GsViewInterface, RedirectionBase >::interactivityFrameRate ( ) const
inline

Returns interactivity frame rate. This method returns 0.0 if there is no redirection view.

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

Definition at line 974 of file GsInterfaceWrappers.h.

◆ invalidate() [1/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::invalidate ( )
inline

Marks the entire area of the wrapped view for refreshing.

Definition at line 877 of file GsInterfaceWrappers.h.

◆ invalidate() [2/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::invalidate ( const OdGsDCRect screenRect)
inline

Marks for refresh the specified region of the wrapped viewport object.

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

Definition at line 888 of file GsInterfaceWrappers.h.

◆ invalidateCachedViewportGeometry()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::invalidateCachedViewportGeometry ( )
inline

Marks for regeneration all subViewportDraw() geometry for the wrapped viewport object.

Definition at line 1068 of file GsInterfaceWrappers.h.

◆ isBackClipped()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isBackClipped ( ) const
inline

Checks whether back clipping is enabled for the wrapped viewport object.

Returns
true if back clipping is enabled for the wrapped viewport object, false otherwise. This method returns false if there is no redirection view.

Definition at line 628 of file GsInterfaceWrappers.h.

◆ isFrontClipped()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isFrontClipped ( ) const
inline

Checks whether front clipping is enabled for the wrapped viewport object.

Returns
true if front clipping is enabled for the wrapped viewport object, false otherwise. This method returns false if there is no redirection view.

Definition at line 584 of file GsInterfaceWrappers.h.

◆ isInInteractivity()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isInInteractivity ( ) const
inline

Checks whether the wrapped viewport object is in interactive state.

Returns
true if the wrapped view is in interactivity mode, false otherwise. This method returns false if there is no redirection view.
See also
<link gs_views_interactivity_mode, Work with Interactivity Mode for Views>

Definition at line 961 of file GsInterfaceWrappers.h.

◆ isPerspective()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isPerspective ( ) const
inline

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

Returns
true if projection type for the wrapped viewport object is kPerspective, false otherwise. This method returns false if there is no redirection view.

Definition at line 539 of file GsInterfaceWrappers.h.

◆ isStereoEnabled()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isStereoEnabled ( ) const
inline

Checks whether stereo viewing is enabled for the wrapped viewport object.

Returns
true if and only if stereo viewing is enabled for the wrapped viewport object, false otherwise. This method returns false if there is no redirection view.

Definition at line 1323 of file GsInterfaceWrappers.h.

◆ isValid()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isValid ( ) const
inline

Checks whether the wrapped viewport shows the correct image.

Returns
true if the wrapped viewport object is showing the correct image, false otherwise. This method returns false if there is no redirection view.
Remarks
This implies the follow: No part of GUI area is flagged for refresh. All rasterizations are complete The rendering pipeline has been flushed.

Definition at line 906 of file GsInterfaceWrappers.h.

◆ isViewportBorderVisible()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isViewportBorderVisible ( ) const
inline

Checks whether viewport border is visibile, false otherwise.

Returns
true the border is visible for the wrapped viewport object, false otherwise. This method returns false if there is no redirection view.

Definition at line 445 of file GsInterfaceWrappers.h.

◆ isVisible()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::isVisible ( )
inline

Checks whether the wrapped viewport object is not hidden. This method returns false if there is no redirection view.

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

Definition at line 1017 of file GsInterfaceWrappers.h.

◆ lensLength()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
double OdGsViewWrapper< GsViewInterface, RedirectionBase >::lensLength ( ) const
inline

Returns the perspective lens length for the wrapped viewport object. This method returns 50.0 if there is no redirection view.

Definition at line 516 of file GsInterfaceWrappers.h.

◆ linetypeAlternateScaleMultiplier()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
double OdGsViewWrapper< GsViewInterface, RedirectionBase >::linetypeAlternateScaleMultiplier ( ) const
inline

Returns current alternate linetype scale multiplier value. This method returns 1.0 if there is no redirection view.

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

Definition at line 1425 of file GsInterfaceWrappers.h.

◆ linetypeScaleMultiplier()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
double OdGsViewWrapper< GsViewInterface, RedirectionBase >::linetypeScaleMultiplier ( ) const
inline

Returns current linetype scale multiplier value. This method returns 1.0 if there is no redirection view.

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

Definition at line 1399 of file GsInterfaceWrappers.h.

◆ lineweightToDcScale()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
double OdGsViewWrapper< GsViewInterface, RedirectionBase >::lineweightToDcScale ( ) const
inline

Returns the scale factor for displaying Lineweights from the wrapped Viewport object. If there is no wrapped view, this method returns 1.0.

See also
<link tv_working_with_attributes_lineweights, Work with Lineweights>

Definition at line 207 of file GsInterfaceWrappers.h.

◆ mode()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGsView::RenderMode OdGsViewWrapper< GsViewInterface, RedirectionBase >::mode ( ) const
inline

Sets the render mode for the wrapped 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.

This method OdGsView::kNone.

Definition at line 760 of file GsInterfaceWrappers.h.

◆ numRootDrawables()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
int OdGsViewWrapper< GsViewInterface, RedirectionBase >::numRootDrawables ( ) const
inline

Retrieves a quantity of root drawables for the wrapped viewport. This method returns 0 if there is no redirection view.

Definition at line 794 of file GsInterfaceWrappers.h.

◆ objectToDeviceMatrix()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGeMatrix3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::objectToDeviceMatrix ( ) const
inline

Returns the matrix that transforms coordinates from model space to screen space for the wrapped viewport object. This method returns identity matrix if there is no redirection view.

Definition at line 708 of file GsInterfaceWrappers.h.

◆ orbit()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::orbit ( double  xOrbit,
double  yOrbit 
)
inline

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.

Definition at line 1161 of file GsInterfaceWrappers.h.

◆ pan()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::pan ( double  xPan,
double  yPan 
)
inline

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.

Definition at line 1194 of file GsInterfaceWrappers.h.

◆ pointInView()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::pointInView ( const OdGePoint3d pt) const
inline

Checks whether specified point is visible inside current view frustum. This method returns false if there is no redirection view.

Parameters
pt[in] WCS point for check.
Returns
true if the specified point is visible in the wrapped viewport, false otherwise.

Definition at line 1232 of file GsInterfaceWrappers.h.

◆ pointInViewport()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::pointInViewport ( const OdGePoint2d screenPoint) const
inline

Checks whether the specified point is inside viewport area. This method returns false if there is no redirection view.

Parameters
screenPoint[in] Check point in device coordinate space.
Returns
true if the passed point is inside the viewport, false otherwise.

Definition at line 1462 of file GsInterfaceWrappers.h.

◆ position()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGePoint3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::position ( ) const
inline

Returns the WCS camera position for the wrapped viewport object. This method returns a 3D point at the origin of world coordinate system if there is no redirection view.

Definition at line 483 of file GsInterfaceWrappers.h.

◆ projectionMatrix()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGeMatrix3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::projectionMatrix ( ) const
inline

Returns the matrix that transforms view space to normalized device space for the wrapped viewport object. This method returns identity matrix if there is no redirection view.

Definition at line 671 of file GsInterfaceWrappers.h.

◆ roll()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::roll ( double  rollAngle)
inline

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.

Definition at line 1139 of file GsInterfaceWrappers.h.

◆ rootDrawableAt()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGiDrawablePtr OdGsViewWrapper< GsViewInterface, RedirectionBase >::rootDrawableAt ( int  i,
OdGsModelPtr pModelReturn 
) const
inline

Retrieves a transient object identifier of the root drawable at the specified index. This method returns a not valid smart pointer to a drawable if there is no redirection view.

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

Definition at line 818 of file GsInterfaceWrappers.h.

◆ rootDrawableIdAt()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdDbStub * OdGsViewWrapper< GsViewInterface, RedirectionBase >::rootDrawableIdAt ( int  i,
OdGsModelPtr pModelReturn 
) const
inline

Retrieves a persistent object identifier of the root drawable at the specified index. This method returns 0 if there is no redirection view.

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

Definition at line 806 of file GsInterfaceWrappers.h.

◆ screenMatrix()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGeMatrix3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::screenMatrix ( ) const
inline

Returns the matrix that transforms normalized device space to screen space for the wrapped viewport object. This method returns identity matrix if there is no redirection view.

Definition at line 682 of file GsInterfaceWrappers.h.

◆ select()

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

Runs selection procedure inside the wrapped 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>

Definition at line 1084 of file GsInterfaceWrappers.h.

◆ setAlternateLinetypeScaleMultiplier()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setAlternateLinetypeScaleMultiplier ( double  linetypeAlternateScaleMultiplier)
inline

Sets a multiplier that could be used as an alternate scale factor for linetypes in the wrapped 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>

Definition at line 1413 of file GsInterfaceWrappers.h.

◆ setBackClip()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setBackClip ( double  backClip)
inline

Sets the back clip distance from the target of the wrapped viewport object.

Parameters
backClip[in] Back clip distance.

Definition at line 639 of file GsInterfaceWrappers.h.

◆ setBackground()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setBackground ( OdDbStub *  backgroundId)
inline

Sets background object for the wrapped view.

Parameters
backgroundId[in] New background object ID.
See also
<link tv_working_with_attributes_view_backgrounds, Work with View Backgrounds>

Definition at line 1494 of file GsInterfaceWrappers.h.

◆ setClearColor()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setClearColor ( OdGsView::ClearColor  color)
inline

Sets the clear color for the wrapped view.

Parameters
color[in] The clear color.

Definition at line 1448 of file GsInterfaceWrappers.h.

◆ setEnableBackClip()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setEnableBackClip ( bool  enable)
inline

Controls the back clipping of the wrapped viewport object.

Parameters
enable[in] Enable back clipping.

Definition at line 616 of file GsInterfaceWrappers.h.

◆ setEnableFrontClip()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setEnableFrontClip ( bool  enable)
inline

Controls the front clipping of the wrapped viewport object.

Parameters
enable[in] Enable front clipping.

Definition at line 572 of file GsInterfaceWrappers.h.

◆ setFrontClip()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setFrontClip ( double  frontClip)
inline

Sets the front clip distance from the target of the wrapped viewport object.

Parameters
frontClip[in] Front clip distance.

Definition at line 595 of file GsInterfaceWrappers.h.

◆ setLensLength()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setLensLength ( double  lensLength)
inline

Sets the perspective lens length for the wrapped viewport object.

Parameters
lensLength[in] Perspective lens length.

Definition at line 527 of file GsInterfaceWrappers.h.

◆ setLinetypeScaleMultiplier()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setLinetypeScaleMultiplier ( double  linetypeScaleMultiplier)
inline

Sets a multiplier that is used to scale all linetypes in the wrapped viewport object.

Parameters
linetypeScaleMultiplier[in] Linetype scale multiplier.

Definition at line 1387 of file GsInterfaceWrappers.h.

◆ setLineweightEnum()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setLineweightEnum ( int  numLineweights,
const OdUInt8 lineweights 
)
inline

Sets the lineweights for the wrapped Viewport object.

Parameters
numLineweights[in] Number of Lineweights.
lineweights[in] Array of Lineweights.
See also
<link tv_working_with_attributes_lineweights, Work with Lineweights>

Definition at line 233 of file GsInterfaceWrappers.h.

◆ setLineweightToDcScale()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setLineweightToDcScale ( double  scale)
inline

Sets the scale factor for displaying Lineweights for the wrapped Viewport object.

Parameters
scale[in] Scale factor.
See also
<link tv_working_with_attributes_lineweights, Work with Lineweights>

Definition at line 220 of file GsInterfaceWrappers.h.

◆ setMode()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setMode ( OdGsView::RenderMode  mode)
inline

Sets the render mode for the wrapped 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.

Definition at line 735 of file GsInterfaceWrappers.h.

◆ setStereoParameters()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setStereoParameters ( double  magnitude,
double  parallax 
)
inline

Sets the stereo parameters for the wrapped 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.

Definition at line 1345 of file GsInterfaceWrappers.h.

◆ setUserGiContext()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setUserGiContext ( OdGiContext pUserGiContext)
inline

Sets current vectorization context.

Parameters
pUserGiContext[in] Pointer to vectorization context.

Definition at line 195 of file GsInterfaceWrappers.h.

◆ setView()

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

Sets the camera parameters for the wrapped 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

Definition at line 472 of file GsInterfaceWrappers.h.

◆ setViewport() [1/3]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewport ( const OdGePoint2d lowerLeft,
const OdGePoint2d upperRight 
)
inline

Sets the size and position for the wrapped 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.

Definition at line 248 of file GsInterfaceWrappers.h.

◆ setViewport() [2/3]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewport ( const OdGsDCRect screenRect)
inline

Sets the size and position of the wrapped 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.

Definition at line 263 of file GsInterfaceWrappers.h.

◆ setViewport() [3/3]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewport ( const OdGsDCRectDouble screenRect)
inline

Sets the size and position of the wrapped 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.

Definition at line 277 of file GsInterfaceWrappers.h.

◆ setViewport3dClipping()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewport3dClipping ( const OdGiClipBoundary pBoundary,
const OdGiAbstractClipBoundary pClipInfo = NULL 
)
inline

Defines the 3d clipping for the wrapped viewport object.

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

Definition at line 386 of file GsInterfaceWrappers.h.

◆ setViewportBorderProperties()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewportBorderProperties ( ODCOLORREF  color,
int  width 
)
inline

Sets the color and width of the border for the wrapped viewport object.

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

Definition at line 412 of file GsInterfaceWrappers.h.

◆ setViewportBorderVisibility()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewportBorderVisibility ( bool  visible)
inline

Controls the border visibility for the wrapped viewport object.

Parameters
visible[in] Controls visibility.

Definition at line 433 of file GsInterfaceWrappers.h.

◆ setViewportClipRegion() [1/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewportClipRegion ( int  numContours,
int const *  numVertices,
OdGePoint2d const *  vertices 
)
inline

Defines a polygonal clip region for the wrapped 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.

Definition at line 350 of file GsInterfaceWrappers.h.

◆ setViewportClipRegion() [2/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setViewportClipRegion ( int  numContours,
int const *  numVertices,
OdGsDCPoint const *  vertices 
)
inline

Defines a polygonal clip region for the wrapped 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.

Definition at line 337 of file GsInterfaceWrappers.h.

◆ setVisualStyle() [1/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setVisualStyle ( const OdGiVisualStyle visualStyle)
inline

Sets visual style for the wrapped view.

Parameters
visualStyle[in] New visual style data.
See also
<link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Definition at line 1546 of file GsInterfaceWrappers.h.

◆ setVisualStyle() [2/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::setVisualStyle ( OdDbStub *  visualStyleId)
inline

Sets visual style object for the wrapped view.

Parameters
visualStyleId[in] New visual style object ID.
See also
<link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Definition at line 1520 of file GsInterfaceWrappers.h.

◆ show()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::show ( )
inline

Un-hides the wrapped viewport object.

Definition at line 1005 of file GsInterfaceWrappers.h.

◆ ssaoMode()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::ssaoMode ( ) const
inline

Returns ambient occlusion mode for current Viewport object.

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

Definition at line 1658 of file GsInterfaceWrappers.h.

◆ target()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGePoint3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::target ( ) const
inline

Returns the WCS camera target for the wrapped viewport object. This method returns (0,0,1) vector if there is no redirection view.

Definition at line 494 of file GsInterfaceWrappers.h.

◆ thawLayer()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::thawLayer ( OdDbStub *  layerID)
inline

Thaws the specified Layer object in the wrapped 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>

Definition at line 1046 of file GsInterfaceWrappers.h.

◆ update()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::update ( )
inline

Flushes any queued graphics to the display device.

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

Definition at line 919 of file GsInterfaceWrappers.h.

◆ upVector()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGeVector3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::upVector ( ) const
inline

Returns the WCS camera up vector for the wrapped viewport object. This method returns (0,1,0) vector if there is no redirection view.

Definition at line 505 of file GsInterfaceWrappers.h.

◆ userGiContext()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGiContext * OdGsViewWrapper< GsViewInterface, RedirectionBase >::userGiContext ( ) const
inline

Retrieves a pointer to the vectorization context. This method returns NULL if there is no redirection view.

Definition at line 184 of file GsInterfaceWrappers.h.

◆ viewingMatrix()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGeMatrix3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::viewingMatrix ( ) const
inline

Returns the matrix that transforms world space to view space for the wrapped viewport object. This method returns identity matrix if there is no redirection view.

Definition at line 660 of file GsInterfaceWrappers.h.

◆ viewParameters()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::viewParameters ( OdGsView pView) const
inline

Sets the view parameters of the specified OdGsView object to that of the wrapped viewport object.

Parameters
pView[out] Receives the view parameters.

Definition at line 1275 of file GsInterfaceWrappers.h.

◆ viewport3dClipping()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
const OdGiClipBoundary * OdGsViewWrapper< GsViewInterface, RedirectionBase >::viewport3dClipping ( const OdGiAbstractClipBoundary **  ppClipInfo = NULL) const
inline

Returns the current 3d clipping for the wrapped viewport object.

Parameters
ppClipInfo[out] Optional 3d clipping boundary extended data.
Remarks
Returns NULL if 3d clipping boundary isn't set or if there is no redirection view.

Definition at line 400 of file GsInterfaceWrappers.h.

◆ viewportClipRegion() [1/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::viewportClipRegion ( OdIntArray counts,
OdGePoint2dArray vertices 
) const
inline

Returns a polygonal clip region for the wrapped 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.

Definition at line 374 of file GsInterfaceWrappers.h.

◆ viewportClipRegion() [2/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::viewportClipRegion ( OdIntArray counts,
OdGsDCPointArray vertices 
) const
inline

Returns a polygonal clip region for the wrapped 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.

Definition at line 362 of file GsInterfaceWrappers.h.

◆ visualStyle() [1/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdDbStub * OdGsViewWrapper< GsViewInterface, RedirectionBase >::visualStyle ( ) const
inline

Returns current visual style object ID for the wrapped view. This method returns NULL if there is no redirection view.

See also
<link tv_working_with_attributes_visual_styles, Work with Visual Styles>

Definition at line 1532 of file GsInterfaceWrappers.h.

◆ visualStyle() [2/2]

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
bool OdGsViewWrapper< GsViewInterface, RedirectionBase >::visualStyle ( OdGiVisualStyle visualStyle) const
inline

Returns current visual style for the wrapped view. This method returns false if there is no redirection 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>

Definition at line 1563 of file GsInterfaceWrappers.h.

◆ worldToDeviceMatrix()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
OdGeMatrix3d OdGsViewWrapper< GsViewInterface, RedirectionBase >::worldToDeviceMatrix ( ) const
inline

Returns a matrix that transforms coordinates from world space to screen space for the wrapped viewport object.

Remarks
This is equivalent to the concatenation of the viewingMatrix, projectionMatrix, and screenMatrix. This method returns identity matrix if there is no redirection view.

Definition at line 697 of file GsInterfaceWrappers.h.

◆ zoom()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::zoom ( double  zoomFactor)
inline

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

Parameters
zoomFactor[in] Zoom factor.

Definition at line 1172 of file GsInterfaceWrappers.h.

◆ zoomExtents()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::zoomExtents ( const OdGePoint3d minPt,
const OdGePoint3d maxPt 
)
inline

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.

Definition at line 1206 of file GsInterfaceWrappers.h.

◆ zoomWindow()

template<typename GsViewInterface = OdGsView, typename RedirectionBase = OdGsDefaultRedirectionBase<OdGsView, GsViewInterface>>
void OdGsViewWrapper< GsViewInterface, RedirectionBase >::zoomWindow ( const OdGePoint2d lowerLeft,
const OdGePoint2d upperRight 
)
inline

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

Definition at line 1218 of file GsInterfaceWrappers.h.


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