OdGsDCPoint Class Reference

#include <GsDefs.h>

Public Types
enum	MaxFlag { Maximum }
enum	MinFlag { Minimum }

Public Member Functions
	OdGsDCPoint ()
	OdGsDCPoint (OdInt32 xx, OdInt32 yy)
	OdGsDCPoint (MaxFlag)
	OdGsDCPoint (MinFlag)
void	operator= (MaxFlag)
void	operator= (MinFlag)
void	operator= (const OdGsDCPoint &dcPoint)
bool	operator== (const OdGsDCPoint &dcPoint) const
bool	operator!= (const OdGsDCPoint &dcPoint) const
long	operator[] (unsigned int i) const

Public Attributes
OdInt32	x
OdInt32	y

Detailed Description

This class represents 2D Device Coordinate points. 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 53 of file GsDefs.h.

Member Enumeration Documentation

MaxFlag

enum OdGsDCPoint::MaxFlag

Maximum values for point coordinates.

Enumerator
Maximum

Definition at line 57 of file GsDefs.h.

MinFlag

enum OdGsDCPoint::MinFlag

Minimum values for point coordinates.

Enumerator
Minimum

Definition at line 59 of file GsDefs.h.

Constructor & Destructor Documentation

OdGsDCPoint() [1/4]

OdGsDCPoint::OdGsDCPoint ( )

inline

Default constructor for the OdGsDCPoint class. Creates an instance with 0 for x and y coordinates.

Definition at line 64 of file GsDefs.h.

OdGsDCPoint() [2/4]

OdGsDCPoint::OdGsDCPoint ( OdInt32  xx, OdInt32  yy  )

inline

Constructor for the OdGsDCPoint class.

Parameters

xx	[in] The X-coordinate of this point.
yy	[in] The Y-coordinate of this point.

Definition at line 76 of file GsDefs.h.

OdGsDCPoint() [3/4]

OdGsDCPoint::OdGsDCPoint ( MaxFlag  )

inline

Constructor for the OdGsDCPoint class. Builds an instance of the object with the following parameters: OdGsDCPoint(Maximum) sets x = SCALAR_MAX, y = SCALAR_MAX

Parameters

MaxFlag

[in] Sets maximum allowed values for x and y axes.

Definition at line 85 of file GsDefs.h.

OdGsDCPoint() [4/4]

OdGsDCPoint::OdGsDCPoint ( MinFlag  )

inline

Constructor for the OdGsDCPoint class. Builds an instance of the object with the following parameters: OdGsDCPoint(Minimum) sets x = SCALAR_MIN, y = SCALAR_MIN

Parameters

MinFlag

[in] Sets minimum allowed values for x and y axes.

Definition at line 93 of file GsDefs.h.

Member Function Documentation

operator!=()

bool OdGsDCPoint::operator!= ( const OdGsDCPoint &  dcPoint ) const

inline

Remarks

Inequality operator for the OdGsDCPoint class. Points are considered not equal if at least one of the following conditions fails: the x coordinate of this point equals to the x coordinate of the passed point the y coordinate of this point equals to the y coordinate of the passed point

Parameters

dcPoint

[in] 2D point in device coordinates to compare.

Definition at line 134 of file GsDefs.h.

operator=() [1/3]

void OdGsDCPoint::operator= ( const OdGsDCPoint &  dcPoint )

inline

Remarks

Assignment operator for the OdGsDCPoint class.

Parameters

dcPoint

[in] 2D point in device coordinates to assign.

Definition at line 114 of file GsDefs.h.

operator=() [2/3]

void OdGsDCPoint::operator= ( MaxFlag  )

inline

Remarks

Assignment operator for the OdGsDCPoint class. Assigns the maximum allowed values for x and y coordinates for this object.

Parameters

MaxFlag

[in] Sets maximum allowed values for x and y axes.

Definition at line 100 of file GsDefs.h.

operator=() [3/3]

void OdGsDCPoint::operator= ( MinFlag  )

inline

Remarks

Assignment operator for the OdGsDCPoint class. Assigns the minimum allowed values for x and y coordinates for this object.

Parameters

MinFlag

[in] Sets minimum allowed values for x and y axes.

Definition at line 107 of file GsDefs.h.

operator==()

bool OdGsDCPoint::operator== ( const OdGsDCPoint &  dcPoint ) const

inline

Remarks

Equality operator for the OdGsDCPoint class. Points are considered equal if: the x coordinate of this point equals to the x coordinate of the passed point the y coordinate of this point equals to the y coordinate of the passed point

Parameters

dcPoint

[in] 2D point in device coordinates to compare.

Definition at line 124 of file GsDefs.h.

operator[]()

long OdGsDCPoint::operator[] ( unsigned int  i ) const

inline

Remarks

Returns i-th coordinate of this point.

Parameters

i	[in] i-th coordinate of this point where 0 is x coordinate and 1 is y coordinate.

Definition at line 141 of file GsDefs.h.

Member Data Documentation

x

OdInt32 OdGsDCPoint::x

Definition at line 144 of file GsDefs.h.

y

OdInt32 OdGsDCPoint::y

Definition at line 145 of file GsDefs.h.

---

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

• GsDefs.h