#include <GiDummyGeometry.h>

Inheritance diagram for OdGiWrapperViewport< T >:

Public Member Functions
virtual OdGeMatrix3d	getModelToEyeTransform () const

virtual OdGeMatrix3d	getEyeToModelTransform () const

virtual OdGeMatrix3d	getWorldToEyeTransform () const

virtual OdGeMatrix3d	getEyeToWorldTransform () const

virtual bool	isPerspective () const

virtual bool	doPerspective (OdGePoint3d &p) const

virtual bool	doInversePerspective (OdGePoint3d &p) const

virtual void	getNumPixelsInUnitSquare (const OdGePoint3d &givenWorldpt, OdGePoint2d &pixelArea, bool includePerspective=true) const

virtual OdGePoint3d	getCameraLocation () const

virtual OdGePoint3d	getCameraTarget () const

virtual OdGeVector3d	getCameraUpVector () const

virtual OdGeVector3d	viewDir () const

virtual OdUInt32	viewportId () const

virtual OdInt16	acadWindowId () const

virtual void	getViewportDcCorners (OdGePoint2d &lower_left, OdGePoint2d &upper_right) const

virtual bool	getFrontAndBackClipValues (bool &clip_front, bool &clip_back, double &front, double &back) const

virtual double	linetypeScaleMultiplier () const

virtual double	linetypeGenerationCriteria () const

virtual bool	layerVisible (OdDbStub *idLayer) const

Protected Member Functions
void	set (const OdGiViewport &ref)

const OdGiViewport &	get () const

Detailed Description

template<class T>
class OdGiWrapperViewport< T >

This class is a dummy template for OdGiViewport. Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 2870 of file GiDummyGeometry.h.

Member Function Documentation

◆ acadWindowId()

template<class T >

virtual OdInt16 OdGiWrapperViewport< T >::acadWindowId ( ) const

inlinevirtual

Returns the ID for the associated window object.

Returns: Id of an associated window as OdInt16 value.

Remarks: The value returned corresponds to the CVPORT system variable.

Definition at line 3019 of file GiDummyGeometry.h.

◆ doInversePerspective()

template<class T >

virtual bool OdGiWrapperViewport< T >::doInversePerspective ( OdGePoint3d & p ) const

inlinevirtual

Applies the inverse of the current perspective transformation to the specified point.

Parameters

point [in/out] Point relative to which the inverse transformation is applied. Receives point coordinates after transformation if successful.

Remarks: The point is transformed from normalized device coordinates to EyeSpace coordinates

true if the point was transformed; i.e., an inverse perspective transform is active, and the point was neither too close or behind the camera.

See also: Coordinate Systems

Definition at line 2946 of file GiDummyGeometry.h.

◆ doPerspective()

template<class T >

virtual bool OdGiWrapperViewport< T >::doPerspective ( OdGePoint3d & p ) const

inlinevirtual

Applies the current perspective transformation to the specified point.

Parameters

p	[in/out] Point relative to which the transformation is applied. Receives point coordinates after transformation if successful.

Remarks: The point is transformed from EyeSpace coordinates to normalized device coordinates.

Returns: true if the point was transformed; i.e., a perspective transform is active, and the point was neither too close or behind the camera.

Definition at line 2930 of file GiDummyGeometry.h.

◆ get()

template<class T >

const OdGiViewport & OdGiWrapperViewport< T >::get ( ) const

inlineprotected

Definition at line 2875 of file GiDummyGeometry.h.

◆ getCameraLocation()

template<class T >

virtual OdGePoint3d OdGiWrapperViewport< T >::getCameraLocation ( ) const

inlinevirtual

Returns the WCS camera (eye) location for the associated camera.

Returns: camera location as OdGePoint3d value.

Definition at line 2973 of file GiDummyGeometry.h.

◆ getCameraTarget()

template<class T >

virtual OdGePoint3d OdGiWrapperViewport< T >::getCameraTarget ( ) const

inlinevirtual

Returns the camera target point for the associated camera.

Returns: camera target point as OdGePoint3d value.

Definition at line 2981 of file GiDummyGeometry.h.

◆ getCameraUpVector()

template<class T >

virtual OdGeVector3d OdGiWrapperViewport< T >::getCameraUpVector ( ) const

inlinevirtual

Returns the WCS camera "up" vector for for the associated camera.

Returns: camera up-vector as OdGeVector3d value.

Definition at line 2989 of file GiDummyGeometry.h.

◆ getEyeToModelTransform()

template<class T >

virtual OdGeMatrix3d OdGiWrapperViewport< T >::getEyeToModelTransform ( ) const

inlinevirtual

Returns the transformation matrix from EyeSpace to ModelSpace for this object.

Returns: EyeSpace to ModelSpace transform matrix.

Definition at line 2892 of file GiDummyGeometry.h.

◆ getEyeToWorldTransform()

template<class T >

virtual OdGeMatrix3d OdGiWrapperViewport< T >::getEyeToWorldTransform ( ) const

inlinevirtual

Returns the transformation matrix from EyeSpace to WCS for this object.

Returns: EyeSpace to WorldSpace transform matrix.

Definition at line 2908 of file GiDummyGeometry.h.

◆ getFrontAndBackClipValues()

template<class T >

virtual bool OdGiWrapperViewport< T >::getFrontAndBackClipValues	(	bool &	clip_front,
		bool &	clip_back,
		double &	front,
		double &	back
	)		const

inlinevirtual

Returns the front and back clipping parameters for the associated Viewport object.

Parameters

clipFront	[out] Receives true if and only if front clipping is enabled.
clipBack	[out] Receives true if and only if back clipping is enabled.
front	[out] Receives the front clipping distance.
back	[out] Receives the back clipping distance.

Returns: true if clipFront || clipBack which means that one of the values is non-zero, false otherwise.

Remarks: front and back are the eye coordinate Z values.

Clipping planes are perpendicular to the view direction.

If the front clipping plane is enabled, geometry in front of it is not displayed.

If the back clipping plane is enabled, geometry in back of it is not displayed.

Definition at line 3058 of file GiDummyGeometry.h.

◆ getModelToEyeTransform()

template<class T >

virtual OdGeMatrix3d OdGiWrapperViewport< T >::getModelToEyeTransform ( ) const

inlinevirtual

Returns the transformation matrix from ModelSpace to EyeSpace for this object.

Returns: ModelSpace to EyeSpace transform matrix.

Definition at line 2884 of file GiDummyGeometry.h.

◆ getNumPixelsInUnitSquare()

template<class T >

virtual void OdGiWrapperViewport< T >::getNumPixelsInUnitSquare	(	const OdGePoint3d &	givenWorldpt,
		OdGePoint2d &	pixelArea,
		bool	includePerspective = `true`
	)		const

inlinevirtual

Returns the display pixel density at the specified point for this object.

Parameters

givenWorldpt	[in] WCS center of the unit square.
pixelArea	[out] Receives the pixel density.
includePerspective	[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 2961 of file GiDummyGeometry.h.

◆ getViewportDcCorners()

template<class T >

virtual void OdGiWrapperViewport< T >::getViewportDcCorners	(	OdGePoint2d &	lower_left,
		OdGePoint2d &	upper_right
	)		const

inlinevirtual

Returns lower-left and upper-right corners of the associated Viewport object in normalized device Coordinates.

Parameters

lowerLeft	[out] Receives the lower-left corner.
upperRight	[out] Receives the upper-right.

Remarks: This information lets position items that are fixed in size and/or position with respect to a Viewport.

See also: Coordinate Systems

Definition at line 3035 of file GiDummyGeometry.h.

◆ getWorldToEyeTransform()

template<class T >

virtual OdGeMatrix3d OdGiWrapperViewport< T >::getWorldToEyeTransform ( ) const

inlinevirtual

Returns the transformation matrix from WCS to EyeSpace for this object.

Returns: WorldSpace to EyeSpace transform matrix.

Definition at line 2900 of file GiDummyGeometry.h.

◆ isPerspective()

template<class T >

virtual bool OdGiWrapperViewport< T >::isPerspective ( ) const

inlinevirtual

Checks whether perspective mode is on for this object.

Returns: true if the perspective mode is on, false otherwise.

Definition at line 2916 of file GiDummyGeometry.h.

◆ layerVisible()

template<class T >

virtual bool OdGiWrapperViewport< T >::layerVisible ( OdDbStub * idLayer ) const

inlinevirtual

Checks whether the specified layer is not frozen either globally or in the associated Viewport object.

Parameters

layerId [in] Identifier of the OdLayerTableRecord to check.

Returns: true the specified layer is not frozen, false otherwise.

Definition at line 3089 of file GiDummyGeometry.h.

◆ linetypeGenerationCriteria()

template<class T >

virtual double OdGiWrapperViewport< T >::linetypeGenerationCriteria ( ) const

inlinevirtual

Returns the WCS value below which linetype generation is not used.

Returns: linetype generation criteria as a value of the double type.

Remarks: If the WCS length an entire linetype pattern is less than the returned value, then the linetype will be rendered as continuous.

Definition at line 3079 of file GiDummyGeometry.h.

◆ linetypeScaleMultiplier()

template<class T >

virtual double OdGiWrapperViewport< T >::linetypeScaleMultiplier ( ) const

inlinevirtual

Returns a multiplier that is used to scale all linetypes in the associated Viewport object.

Returns: multiplier for the linetype scale as value of the double type.

Definition at line 3067 of file GiDummyGeometry.h.

◆ set()

template<class T >

void OdGiWrapperViewport< T >::set ( const OdGiViewport & ref )

inlineprotected

Definition at line 2874 of file GiDummyGeometry.h.

◆ viewDir()

template<class T >

virtual OdGeVector3d OdGiWrapperViewport< T >::viewDir ( ) const

inlinevirtual

Returns the vector from the camera target to the camera location.

Returns: camera view direction as OdGeVector3d value.

Definition at line 2997 of file GiDummyGeometry.h.

◆ viewportId()

template<class T >

virtual OdUInt32 OdGiWrapperViewport< T >::viewportId ( ) const

inlinevirtual

Returns the OdGi Viewport ID for this object.

Returns: Id of an associated viewport as OdUInt32 value.

Remarks: The value returned has no relationshp to the CVPORT system variable.

Definition at line 3008 of file GiDummyGeometry.h.

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

GiDummyGeometry.h

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ acadWindowId()

◆ doInversePerspective()

◆ doPerspective()

◆ get()

◆ getCameraLocation()

◆ getCameraTarget()

◆ getCameraUpVector()

◆ getEyeToModelTransform()

◆ getEyeToWorldTransform()

◆ getFrontAndBackClipValues()

◆ getModelToEyeTransform()

◆ getNumPixelsInUnitSquare()

◆ getViewportDcCorners()

◆ getWorldToEyeTransform()

◆ isPerspective()

◆ layerVisible()

◆ linetypeGenerationCriteria()

◆ linetypeScaleMultiplier()

◆ set()

◆ viewDir()

◆ viewportId()