Class: THairlinePainter

Declaration: HairlinePainter.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPainter

Inherited By:

None.

Purpose:

The THairlinePainter class derives from the base class that establishes painters. Painters are responsible for colors and patterns for graphics and images, and are associated with frame buffers. The THairlinePainter class handles line images.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: THairlinePainter::~THairlinePainter

virtual ~ THairlinePainter ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: THairlinePainter::PaintHairlineSteppingInX

virtual void PaintHairlineSteppingInX (TLongPoint & currentPixel, Fixed subpixelYPosition, Fixed yFractionalStep, long stepsToTake, bool steppingRightward)

Interface Category:

API.

Purpose:

Calculates the image pattern along the horizontal axis.

Calling Context:

Call this function directly.

Parameters:

TLongPoint & currentPixel -The current pixel point.
Fixed subpixelYPosition -The vertical pixel position.
Fixed yFractionalStep -The vertical direction to move in and the amount of that move.
long stepsToTake -The number or quantity of moves in the yFractionalStep direction.
bool steppingRightward -A Boolean value that indicates that movement is proceeding to the right.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: THairlinePainter::PaintHairlineSteppingInY

virtual void PaintHairlineSteppingInY (TLongPoint & currentPixel, Fixed subpixelXPosition, Fixed xFractionalStep, long stepsToTake, bool steppingDownward)

Interface Category:

API.

Purpose:

Calculates the image pattern along the vertical axis.

Calling Context:

Call this function directly.

Parameters:

TLongPoint & currentPixel -The current pixel point.
Fixed subpixelXPosition -The horizontal pixel position.
Fixed xFractionalStep -The horizontal direction to move in and the amount of that move.
long stepsToTake -The number or quantity of moves in the xFractionalStep direction.
bool steppingDownward -A Boolean value that indicates that movement is proceeding downward.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: THairlinePainter::PaintClippedHairlineSteppingInX

virtual void PaintClippedHairlineSteppingInX (TLongPoint & currentPixel, Fixed subpixelYPosition, Fixed yFractionalStep, long stepsToTake, bool steppingRightward, const TLongRect & clippingRect)

Interface Category:

API.

Purpose:

Calculates the image pattern along the horizontal axis, taking into consideration clipping boundaries.

Calling Context:

Call this function directly.

Parameters:

TLongPoint & currentPixel -The current pixel point.
Fixed subpixelYPosition -The vertical pixel position.
Fixed yFractionalStep -The vertical direction to move in and the amount of that move.
long stepsToTake -The number or quantity of moves in the yFractionalStep direction.
bool steppingRightward -A Boolean value that indicates that movement is proceeding to the right.
const TLongRect & clippingRect -The rectangle boundaries for the clipping area.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: THairlinePainter::PaintClippedHairlineSteppingInY

virtual void PaintClippedHairlineSteppingInY (TLongPoint & currentPixel, Fixed subpixelXPosition, Fixed xFractionalStep, long stepsToTake, bool steppingDownward, const TLongRect & clippingRect)

Interface Category:

API.

Purpose:

Calculates the image pattern along the vertical axis.

Calling Context:

Call this function directly.

Parameters:

TLongPoint & currentPixel -The current pixel point.
Fixed subpixelXPosition -The horizontal pixel position.
Fixed xFractionalStep -The horizontal direction to move in and the amount of that move.
long stepsToTake -The number or quantity of moves in the xFractionalStep direction.
bool steppingDownward -A Boolean value that indicates that movement is proceeding downward.
const TLongRect & clippingRect -The rectangle boundaries for the clipping area.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: THairlinePainter::PaintBlock

virtual void PaintBlock (GDevCoordinate y, GDevCoordinate x1, GDevCoordinate x2, unsigned long count)

Interface Category:

API.

Purpose:

Fills the rectilinear area with the paint graphics.

Calling Context:

Call this function directly.

Parameters:

GDevCoordinate y -The y-coordinate for the graphics area.
GDevCoordinate x1 -The x1-coordinate for the graphics area.
GDevCoordinate x2 -The x2-coordinate for the graphics area.
unsigned long count -A value that refers to the number of graphics lines.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: THairlinePainter::THairlinePainter

THairlinePainter ()
THairlinePainter (const THairlinePainter & source)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and derived classes.
Called to copy an object.

Parameters:

Takes no parameters.
const THairlinePainter & source -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: THairlinePainter::operator=

const THairlinePainter & operator =(const THairlinePainter & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const THairlinePainter & source -The object that is being assigned.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.