CFx SDK Documentation  2023 SP0
Public Member Functions | Static Public Member Functions | List of all members
CFxViewportSnapShot Class Reference

#include <FxView.h>

Public Member Functions

 CFxViewportSnapShot ()
 
bool InitializeFromView (const CFxView *pView)
 
bool InitializeFromViewInfo (const CFxViewDrawInfo *pViewInfo)
 
void ApplyToView (CFxView *pView)
 
const OdGePoint3dGetPosition () const
 
const OdGePoint3dGetTarget () const
 
const OdGeVector3dGetEyeVector () const
 
const OdGeVector3dGetUpVector () const
 
double GetFieldWidth () const
 
double GetFieldHeight () const
 
double GetPixelWidth () const
 
double GetPixelHeight () const
 
double GetFocalLength () const
 
const OdGeMatrix3dGetWorldToEyeMatrix () const
 
const OdGsDCRectDoubleGetVisibleRect () const
 
OdGePoint2d GetNumPixelsInUnitSquare (double iWidthInPixels, double iHeighInPixels, const OdGePoint3d &point, bool bUsePerspective) const
 

Static Public Member Functions

static bool IsViewSettingsValid (const OdGsView *pView)
 
static bool IsViewSettingsValid (const OdDbViewport *pViewport)
 
static bool IsViewExtentsValid (const OdGeExtents3d &extents)
 

Detailed Description

Description: Represents a viewport snap shot. Library: DDKERNEL

Definition at line 47 of file FxView.h.

Constructor & Destructor Documentation

◆ CFxViewportSnapShot()

CFxViewportSnapShot::CFxViewportSnapShot ( )

Member Function Documentation

◆ ApplyToView()

void CFxViewportSnapShot::ApplyToView ( CFxView pView)

Description: Applies to view described by pView. Arguments:

Parameters
[in,out]pViewIf non-null, the view.

◆ GetEyeVector()

const OdGeVector3d& CFxViewportSnapShot::GetEyeVector ( ) const
inline

Description: Gets the eye vector.

Return Value: The eye vector.

Definition at line 108 of file FxView.h.

◆ GetFieldHeight()

double CFxViewportSnapShot::GetFieldHeight ( ) const
inline

Description: Gets the field height.

Return Value: The field height.

Definition at line 141 of file FxView.h.

◆ GetFieldWidth()

double CFxViewportSnapShot::GetFieldWidth ( ) const
inline

Description: Gets the field width.

Return Value: The field width.

Definition at line 130 of file FxView.h.

◆ GetFocalLength()

double CFxViewportSnapShot::GetFocalLength ( ) const
inline

Description: Gets the focal length.

Return Value: The focal length.

Definition at line 174 of file FxView.h.

◆ GetNumPixelsInUnitSquare()

OdGePoint2d CFxViewportSnapShot::GetNumPixelsInUnitSquare ( double  iWidthInPixels,
double  iHeighInPixels,
const OdGePoint3d point,
bool  bUsePerspective 
) const

◆ GetPixelHeight()

double CFxViewportSnapShot::GetPixelHeight ( ) const
inline

Description: Gets the field height.

Return Value: The field height.

Definition at line 163 of file FxView.h.

◆ GetPixelWidth()

double CFxViewportSnapShot::GetPixelWidth ( ) const
inline

Description: Gets the field width.

Return Value: The field width.

Definition at line 152 of file FxView.h.

◆ GetPosition()

const OdGePoint3d& CFxViewportSnapShot::GetPosition ( ) const
inline

Description: Gets the position.

Return Value: The position.

Definition at line 86 of file FxView.h.

◆ GetTarget()

const OdGePoint3d& CFxViewportSnapShot::GetTarget ( ) const
inline

Description: Gets the target.

Return Value: The target.

Definition at line 97 of file FxView.h.

◆ GetUpVector()

const OdGeVector3d& CFxViewportSnapShot::GetUpVector ( ) const
inline

Description: Gets the up vector.

Return Value: The up vector.

Definition at line 119 of file FxView.h.

◆ GetVisibleRect()

const OdGsDCRectDouble& CFxViewportSnapShot::GetVisibleRect ( ) const
inline

Definition at line 190 of file FxView.h.

◆ GetWorldToEyeMatrix()

const OdGeMatrix3d& CFxViewportSnapShot::GetWorldToEyeMatrix ( ) const
inline

Description: Gets the world to device matrix.

Return Value: The world to device matrix.

Definition at line 185 of file FxView.h.

◆ InitializeFromView()

bool CFxViewportSnapShot::InitializeFromView ( const CFxView pView)

Description: Initializes this object from the given initialize from view. Arguments:

Parameters
pViewThe view.

Return Value: true if it succeeds, false if it fails.

◆ InitializeFromViewInfo()

bool CFxViewportSnapShot::InitializeFromViewInfo ( const CFxViewDrawInfo pViewInfo)

Description: Initializes this object from the given initialize from view info. Arguments:

Parameters
pViewThe view.

Return Value: true if it succeeds, false if it fails.

◆ IsViewExtentsValid()

static bool CFxViewportSnapShot::IsViewExtentsValid ( const OdGeExtents3d extents)
static

Description: Query if 'extents' is view extents valid. Arguments:

Parameters
extentsThe extents.

Return Value: true if view extents valid, false if not.

◆ IsViewSettingsValid() [1/2]

static bool CFxViewportSnapShot::IsViewSettingsValid ( const OdDbViewport pViewport)
static

Description: Query if 'pView' is view settings valid. Arguments:

Parameters
pViewThe view.

Return Value: true if view settings valid, false if not.

◆ IsViewSettingsValid() [2/2]

static bool CFxViewportSnapShot::IsViewSettingsValid ( const OdGsView pView)
static

Description: Query if 'pView' is view settings valid. Arguments:

Parameters
pViewThe view.

Return Value: true if view settings valid, false if not.


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