ViewProps Struct Reference

#include <GsViewProps.h>

Public Member Functions
	ViewProps ()
void	set (const OdGsViewImpl &view)
OdUInt32	difference (const ViewProps &props) const
bool	isCompatibleWith (const ViewProps &props, OdUInt32 nFlags, bool bCompareFrozenLayers=true) const
bool	isInvalid () const
void	setInvalid (bool bValue)

Public Attributes
OdUInt32	m_vpId
OdDbStub *	m_vpObjectId
OdGiRegenType	m_regenType
OdGsView::RenderMode	m_renderMode
OdGeMatrix3d	m_worldToEye
OdGePoint3d	m_cameraLocation
OdGePoint3d	m_cameraTarget
OdGeVector3d	m_cameraUpVector
OdGeVector3d	m_viewDir
OdGePoint2d	m_vpLowerLeft
OdGePoint2d	m_vpUpperRight
double	m_deviation [5]
double	m_frontClip
double	m_backClip
OdDbStubPtrArray	m_frozenLayers
double	m_linetypeScaleMultiplier
const void *	m_renderModule
OdDbStub *	m_annoScale
OdIntPtr	m_filterFunction
OdDbStub *	m_visualStyle
OdUInt32	m_nViewChanges

Detailed Description

Corresponding C++ library: TD_Gs

<group !!RECORDS_TD_APIRef>

Definition at line 42 of file GsViewProps.h.

Constructor & Destructor Documentation

ViewProps()

ViewProps::ViewProps

(

)

Default constructor for the ViewProps class. Sets the following data members:

member Value Description m_vpId 0 Viewport ID. m_vpObjectId NULL Persistent viewport object ID. m_regenType eOdGiRegenTypeInvalid Regeneration type of the view. m_renderMode OdGsView::k2DOptimized View render mode. m_frontClip .0 Front clip distance from the target of the viewport. m_backClip .0 Back clip distance from the target of the viewport. m_linetypeScaleMultiplier .0 Linetype scale multiplier. m_renderModule NULL Module that is used for rendering. m_annoScale NULL Persistent annotation scale object ID. m_filterFunction 0 Drawables filtration function. m_visualStyle NULL Visual style. m_nViewChanges 0 View changes flags.

The constructor also sets deviation values for all deviation types that are used for current vectorization to 0.

Member Function Documentation

difference()

OdUInt32 ViewProps::difference

(

const ViewProps &

props

)

const

Retrieves a set of flags that are different from the specified view properties. See enum located in GsViewPropsDef.h.

Parameters

props

[in] View properties to compare.

isCompatibleWith()

bool ViewProps::isCompatibleWith ( const ViewProps &  props, OdUInt32  nFlags, bool  bCompareFrozenLayers = true  ) const

inline

Checks whether view the passed view properties are compatible with this view properties.

Parameters

props	[in] View properties to compare.
nFlags	[in] Mask that defines which properties to compare.
bCompareFrozenLayers	[in] Flag that specifies whether to compare frozen layers.

Returns

true if view the passed view properties are compatible with this view properties, false otherwise.

Definition at line 325 of file GsViewProps.h.

isInvalid()

bool ViewProps::isInvalid ( ) const

inline

Checks whether view properties are invalid.

Returns

true if view properties are invalid, false otherwise.

Definition at line 162 of file GsViewProps.h.

set()

void ViewProps::set

(

const OdGsViewImpl &

view

)

Sets view properties from the specified view.

Parameters

view	[in] View.

setInvalid()

void ViewProps::setInvalid ( bool  bValue )

inline

Specifies whether view properties are invalid.

Parameters

bValue

[in] Flag that specifies whether view properties are invalid.

Definition at line 169 of file GsViewProps.h.

Member Data Documentation

m_annoScale

OdDbStub* ViewProps::m_annoScale

Persistent annotation scale object ID.

Definition at line 119 of file GsViewProps.h.

m_backClip

double ViewProps::m_backClip

Back clip distance from the target of the viewport.

Definition at line 107 of file GsViewProps.h.

m_cameraLocation

OdGePoint3d ViewProps::m_cameraLocation

Camera location.

Definition at line 83 of file GsViewProps.h.

m_cameraTarget

OdGePoint3d ViewProps::m_cameraTarget

Camera target.

Definition at line 86 of file GsViewProps.h.

m_cameraUpVector

OdGeVector3d ViewProps::m_cameraUpVector

Camera "up" vector.

Definition at line 89 of file GsViewProps.h.

m_deviation

double ViewProps::m_deviation[5]

Valuee for deviation types.

Definition at line 101 of file GsViewProps.h.

m_filterFunction

OdIntPtr ViewProps::m_filterFunction

Pointer to the drawables filtration function.

Definition at line 122 of file GsViewProps.h.

m_frontClip

double ViewProps::m_frontClip

Front clip distance from the target of the viewport.

Definition at line 104 of file GsViewProps.h.

m_frozenLayers

OdDbStubPtrArray ViewProps::m_frozenLayers

Array of frozen layers.

Definition at line 110 of file GsViewProps.h.

m_linetypeScaleMultiplier

double ViewProps::m_linetypeScaleMultiplier

Linetype scale multiplier.

Definition at line 113 of file GsViewProps.h.

m_nViewChanges

OdUInt32 ViewProps::m_nViewChanges

View changes flags.

Definition at line 128 of file GsViewProps.h.

m_regenType

OdGiRegenType ViewProps::m_regenType

Regeneration type.

Definition at line 74 of file GsViewProps.h.

m_renderMode

OdGsView::RenderMode ViewProps::m_renderMode

View render mode.

Definition at line 77 of file GsViewProps.h.

m_renderModule

const void* ViewProps::m_renderModule

Module that is used for rendering.

Definition at line 116 of file GsViewProps.h.

m_viewDir

OdGeVector3d ViewProps::m_viewDir

Vector from the camera target to the camera location.

Definition at line 92 of file GsViewProps.h.

m_visualStyle

OdDbStub* ViewProps::m_visualStyle

Visual style.

Definition at line 125 of file GsViewProps.h.

m_vpId

OdUInt32 ViewProps::m_vpId

Viewport ID.

Definition at line 68 of file GsViewProps.h.

m_vpLowerLeft

OdGePoint2d ViewProps::m_vpLowerLeft

Viewport lower left point.

Definition at line 95 of file GsViewProps.h.

m_vpObjectId

OdDbStub* ViewProps::m_vpObjectId

Persistent viewport object ID.

Definition at line 71 of file GsViewProps.h.

m_vpUpperRight

OdGePoint2d ViewProps::m_vpUpperRight

Viewport upper right point.

Definition at line 98 of file GsViewProps.h.

m_worldToEye

OdGeMatrix3d ViewProps::m_worldToEye

World to eye transformation matrix.

Definition at line 80 of file GsViewProps.h.

---

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

• GsViewProps.h