CFx SDK Documentation  2023 SP0
Public Types | Public Member Functions | Public Attributes | List of all members
OdGsDCRect Class Reference

#include <GsDefs.h>

Public Types

enum  NullFlag { Null }
 

Public Member Functions

 OdGsDCRect ()
 
 OdGsDCRect (const OdGsDCPoint &minPoint, const OdGsDCPoint &maxPoint)
 
 OdGsDCRect (long xMin, long xMax, long yMin, long yMax)
 
 OdGsDCRect (NullFlag)
 
OdGsDCRectoperator= (const OdGsDCRect &dcRect)
 
void operator|= (const OdGsDCRect &dcRect)
 
void operator&= (const OdGsDCRect &dcRect)
 
bool operator== (const OdGsDCRect &dcRect) const
 
bool operator!= (const OdGsDCRect &dcRect) const
 
void set_null ()
 
bool is_null () const
 
bool within (const OdGsDCRect &dcRect) const
 
void offset (long x, long y)
 
void intersectWith (const OdGsDCRect &dcRect, bool bValidate=true)
 
void normalize ()
 

Public Attributes

OdGsDCPoint m_min
 
OdGsDCPoint m_max
 

Detailed Description

This class represents 2D device coordinate rectangles. Corresponding C++ library: TD_Gs

Remarks
Device coordinates are measured in pixels from the lower-left corner of the device.
See also
Coordinate Systems.

<group OdGs_Classes>

Definition at line 110 of file GsDefs.h.

Member Enumeration Documentation

◆ NullFlag

Enumerator
Null 

Definition at line 113 of file GsDefs.h.

Constructor & Destructor Documentation

◆ OdGsDCRect() [1/4]

OdGsDCRect::OdGsDCRect ( )
inline
Parameters
minPoint[in] Lower-left corner.
maxPoint[in] Upper-right corner.
xMin[in] Minimum X-coordinate.
xMax[in] Maximum X-coordinate.
yMin[in] Minimum Y-coordinate.
yMax[in] Maximum Y-coordinate.

Definition at line 121 of file GsDefs.h.

◆ OdGsDCRect() [2/4]

OdGsDCRect::OdGsDCRect ( const OdGsDCPoint minPoint,
const OdGsDCPoint maxPoint 
)
inline

Definition at line 122 of file GsDefs.h.

◆ OdGsDCRect() [3/4]

OdGsDCRect::OdGsDCRect ( long  xMin,
long  xMax,
long  yMin,
long  yMax 
)
inline

Definition at line 123 of file GsDefs.h.

◆ OdGsDCRect() [4/4]

OdGsDCRect::OdGsDCRect ( NullFlag  )
inline

Definition at line 124 of file GsDefs.h.

Member Function Documentation

◆ intersectWith()

void OdGsDCRect::intersectWith ( const OdGsDCRect dcRect,
bool  bValidate = true 
)
inline

Definition at line 199 of file GsDefs.h.

◆ is_null()

bool OdGsDCRect::is_null ( ) const
inline

Returns true if and only if this rectangle object is the null rectangle.

Definition at line 168 of file GsDefs.h.

◆ normalize()

void OdGsDCRect::normalize ( )
inline

Definition at line 215 of file GsDefs.h.

◆ offset()

void OdGsDCRect::offset ( long  x,
long  y 
)
inline

Definition at line 191 of file GsDefs.h.

◆ operator!=()

bool OdGsDCRect::operator!= ( const OdGsDCRect dcRect) const
inline

Definition at line 152 of file GsDefs.h.

◆ operator&=()

void OdGsDCRect::operator&= ( const OdGsDCRect dcRect)
inline

Definition at line 144 of file GsDefs.h.

◆ operator=()

OdGsDCRect& OdGsDCRect::operator= ( const OdGsDCRect dcRect)
inline

Definition at line 126 of file GsDefs.h.

◆ operator==()

bool OdGsDCRect::operator== ( const OdGsDCRect dcRect) const
inline

Definition at line 148 of file GsDefs.h.

◆ operator|=()

void OdGsDCRect::operator|= ( const OdGsDCRect dcRect)
inline

Definition at line 132 of file GsDefs.h.

◆ set_null()

void OdGsDCRect::set_null ( )
inline

Sets this rectangle object to the null rectangle.

Definition at line 159 of file GsDefs.h.

◆ within()

bool OdGsDCRect::within ( const OdGsDCRect dcRect) const
inline

Returns true if and only if this rectangle object is inside the specified rectangle object.

Parameters
dcRect[in] Any display coordinate rectangle.
Remarks
A coincident edge is considered inside.

Definition at line 182 of file GsDefs.h.

Member Data Documentation

◆ m_max

OdGsDCPoint OdGsDCRect::m_max

Definition at line 225 of file GsDefs.h.

◆ m_min

OdGsDCPoint OdGsDCRect::m_min

Definition at line 224 of file GsDefs.h.


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