PrevNextUpHome SophiaFramework UNIVERSE 5.3
SFXPixel
Class which represents a pixel coordinate.
#include <SFXPixel.h.hpp>
class SFXPixel;
SFMTYPEDEFCLASS(SFXPixel)

Description

SFXPixel is the class that handles the pixel coordinates.

In SophiaFramework, there are 2 coordinate systems: grid coordinate system and pixel coordinate system. The pixel coordinates form a dot on the screen.

The difference between the 2 coordinate systems is as follows:

Comparing to the "Go" game or the Japanese Chess game, the drawing plain is like the playing board, the grid is like the place to put the "Go" stone, the pixel is like the place to put the horse of the Japanese Chess game.

Reference

SFXGrid

Member

Constructor/Destructor
SFXPixel( Void )
Constructor of the SFXPixel class.
SFXPixel( SFXPixelConstRef param )
Constructor of the SFXPixel class.
SFXPixel( SInt16 x , SInt16 y )
Constructor of the SFXPixel class.
Public Functions
SFXPixelRef Add( SFXPixelConstRef param )
Add the specified value to the coordinates.
SFXPixelRef Add( SInt16 x , SInt16 y )
Add the specified value to the coordinates.
SFXPixelRef AddX( SInt16 param )
Add the specified value to the X coordinate.
SFXPixelRef AddY( SInt16 param )
Add the specified value to the Y coordinate.
SFXPixelRef Div( SInt16 x , SInt16 y )
Divide the coordinates by the specified value.
SFXPixelRef Div( SInt16 param )
Divide the coordinates by the specified value.
SFXPixelRef DivX( SInt16 param )
Divide the X coordinate by the specified value.
SFXPixelRef DivY( SInt16 param )
Divide the Y coordinate by the specified value.
Bool Equals( SFXPixelConstRef param )
Check whether this pixel equals the specified pixel or not.
Bool Equals( SInt16 x , SInt16 y )
Check whether this pixel equals the specified pixel or not.
SInt16 GetBottom( Void )
Get the Y coordinate of the bottom edge.
SInt16 GetLeft( Void )
Get the X coordinate of the left edge.
SFXGrid GetLeftBottom( Void )
Get the coordinates of left-bottom point.
SFXGrid GetLeftTop( Void )
Get the coordinates of left-top point.
SInt16 GetRight( Void )
Get the X coordinate of the right edge.
SFXGrid GetRightBottom( Void )
Get the coordinates of right-bottom point.
SFXGrid GetRightTop( Void )
Get the coordinates of right-top point.
SInt16 GetTop( Void )
Get the Y coordinate of top edge.
SInt16 GetX( Void )
Get the X coordinate.
SInt16 GetY( Void )
Get the Y coordinate.
Bool IsInsideOf( SFXRectangleConstRef param )
Check whether this pixel is inside of the specified rectangular area or not.
SFXPixelRef Mod( SInt16 x , SInt16 y )
Set the coordinates to the remainder of the division of this coordinates by the specified value.
SFXPixelRef Mod( SInt16 param )
Set the coordinates to the remainder of the division of this coordinates by the specified value.
SFXPixelRef ModX( SInt16 param )
Set the X coordinate to the remainder of the division of X coordinate by the specified value.
SFXPixelRef ModY( SInt16 param )
Set the Y coordinate to the remainder of the division of Y coordinate by the specified value.
SFXPixelRef Mul( SInt16 x , SInt16 y )
Multiply the coordinates by the specified value.
SFXPixelRef Mul( SInt16 param )
Multiply the coordinates by the specified value.
SFXPixelRef MulX( SInt16 param )
Multiply the X coordinate by the specified value.
SFXPixelRef MulY( SInt16 param )
Multiply the Y coordinate by the specified value.
SFXPixelRef Neg( Void )
Negate the sign of the coordinates.
SFXPixelRef NegX( Void )
Negate the sign of the X coordinate.
SFXPixelRef NegY( Void )
Negate the sign of the Y coordinate.
SFXPixelRef Offset( SFXGridConstRef param )
Add the specified value to the coordinates and move this pixel.
SFXPixelRef Offset( SInt16 x , SInt16 y )
Add the specified value to the coordinates and move this pixel.
SFXPixelRef Set( SFXPixelConstRef param )
Set the pixel.
SFXPixelRef Set( SInt16 x , SInt16 y )
Set the pixel.
SFXPixelRef SetBottom( SInt16 param )
Set the Y coordinate of the bottom edge.
SFXPixelRef SetLeft( SInt16 param )
Set the X coordinate of the left edge.
SFXPixelRef SetLeftBottom( SFXGridConstRef param )
Set the coordinates of left-bottom point.
SFXPixelRef SetLeftBottom( SInt16 x , SInt16 y )
Set the coordinates of left-bottom point.
SFXPixelRef SetLeftTop( SFXGridConstRef param )
Set the coordinates of left-top point.
SFXPixelRef SetLeftTop( SInt16 x , SInt16 y )
Set the coordinates of left-top point.
SFXPixelRef SetRight( SInt16 param )
Set the X coordinate of the right edge.
SFXPixelRef SetRightBottom( SFXGridConstRef param )
Set the coordinates of right-bottom point.
SFXPixelRef SetRightBottom( SInt16 x , SInt16 y )
Set the coordinates of right-bottom point.
SFXPixelRef SetRightTop( SFXGridConstRef param )
Set the coordinates of right-top point.
SFXPixelRef SetRightTop( SInt16 x , SInt16 y )
Set the coordinates of right-top point.
SFXPixelRef SetTop( SInt16 param )
Set the Y coordinate of the top edge.
SFXPixelRef SetX( SInt16 param )
Set the X coordinate.
SFXPixelRef SetY( SInt16 param )
Set the Y coordinate.
SFXPixelRef Sub( SFXPixelConstRef param )
Subtract the specified value from the coordinates.
SFXPixelRef Sub( SInt16 x , SInt16 y )
Subtract the specified value from the coordinates.
SFXPixelRef SubX( SInt16 param )
Subtract the specified value from the X coordinate.
SFXPixelRef SubY( SInt16 param )
Subtract the specified value from the Y coordinate.
SFXPixelRef Unoffset( SFXGridConstRef param )
Subtract the coordinate and move this pixel.
SFXPixelRef Unoffset( SInt16 x , SInt16 y )
Subtract the coordinate and move this pixel.
static
SFXPixelConstRef
ZeroInstance( Void )
Get the instance that represents 0.
SFXPixelRef operator%=( SInt16 param )
Set the coordinates to the remainder of the division of this coordinates by the specified value.
SFXPixelRef operator*=( SInt16 param )
Multiply the coordinates by the specified value.
SFXPixelRef operator+=( SFXPixelConstRef param )
Add the specified value to the coordinates and move this pixel.
SFXPixelRef operator+=( SFXGridConstRef param )
Add the specified value to the coordinates and move this pixel.
SFXPixelRef operator-=( SFXPixelConstRef param )
Subtract the specified value from the coordinates and move this pixel.
SFXPixelRef operator-=( SFXGridConstRef param )
Subtract the specified value from the coordinates and move this pixel.
SFXPixelRef operator/=( SInt16 param )
Divide the coordinates by the specified value.
SFXPixelRef operator=( SFXPixelConstRef param )
Assign a pixel.
SFXPixel::AtomRec * atomic_cast( SFXPixel * param )
Convert SFXPixel into SFXPixel::AtomRec.
SFXPixel::AtomRec const * atomic_cast( SFXPixel const * param )
Convert SFXPixel into SFXPixel::AtomRec.
SFXPixel operator/( SFXPixelConstRef left , SInt16 right )
Divide the coordinates by the specified value.
Bool operator==( SFXPixelConstRef left , SFXPixelConstRef right )
Check the "==" relation.
SFXPixel operator-( Void )
Subtract the specified value from the coordinates and move this pixel.
SFXPixel operator-( SFXPixelConstRef left , SFXPixelConstRef right )
Subtract the specified value from the coordinates and move this pixel.
SFXPixel operator-( SFXPixelConstRef left , SFXGridConstRef right )
Subtract the specified value from the coordinates and move this pixel.
SFXPixel operator%( SFXPixelConstRef left , SInt16 right )
Set the coordinates to the remainder of the division of this coordinates by the specified value.
SFXPixel operator*( SFXPixelConstRef left , SInt16 right )
Multiply the coordinates by the specified value.
Bool operator!=( SFXPixelConstRef left , SFXPixelConstRef right )
Check the "!=" relation.
SFXPixel operator+( Void )
Add the coordinate and move this pixel.
SFXPixel operator+( SFXPixelConstRef left , SFXPixelConstRef right )
Add the coordinate and move this pixel.
SFXPixel operator+( SFXPixelConstRef left , SFXGridConstRef right )
Add the coordinate and move this pixel.
Types
AtomRec
Structure that represents a pixel.
Global Functions
SFXPixel::AtomRec * atomic_cast( SFXPixel * param )
Convert SFXPixel into SFXPixel::AtomRec.
SFXPixel::AtomRec const * atomic_cast( SFXPixel const * param )
Convert SFXPixel into SFXPixel::AtomRec.
SFXPixel operator/( SFXPixelConstRef left , SInt16 right )
Divide the coordinates by the specified value.
Bool operator==( SFXPixelConstRef left , SFXPixelConstRef right )
Check the "==" relation.
SFXPixel operator-( Void )
Subtract the specified value from the coordinates and move this pixel.
SFXPixel operator-( SFXPixelConstRef left , SFXPixelConstRef right )
Subtract the specified value from the coordinates and move this pixel.
SFXPixel operator-( SFXPixelConstRef left , SFXGridConstRef right )
Subtract the specified value from the coordinates and move this pixel.
SFXPixel operator%( SFXPixelConstRef left , SInt16 right )
Set the coordinates to the remainder of the division of this coordinates by the specified value.
SFXPixel operator*( SFXPixelConstRef left , SInt16 right )
Multiply the coordinates by the specified value.
Bool operator!=( SFXPixelConstRef left , SFXPixelConstRef right )
Check the "!=" relation.
SFXPixel operator+( Void )
Add the coordinate and move this pixel.
SFXPixel operator+( SFXPixelConstRef left , SFXPixelConstRef right )
Add the coordinate and move this pixel.
SFXPixel operator+( SFXPixelConstRef left , SFXGridConstRef right )
Add the coordinate and move this pixel.

SFXPixel::SFXPixel
Constructor of the SFXPixel class.
[ public, explicit ]
SFXPixel(Void);
[ public ]
SFXPixel(
    SFXPixelConstRef param   // source pixel
);
[ public, explicit ]
SFXPixel(
    SInt16 x   // X coordinate
    SInt16 y   // Y coordinate
);

Description

If the arguments are specified, this constructer will set this pixel to the specified values by calling the SFXPixel::Set function internally.

Reference

SFXPixel::Set


SFXPixel::Add
Add the specified value to the coordinates.
[ public ]
SFXPixelRef Add(
    SFXPixelConstRef param   // value to add to the coordinates
);
[ public ]
SFXPixelRef Add(
    SInt16 x   // value to add to the X coordinate
    SInt16 y   // value to add to the Y coordinate
);

Reference

SFXPixel::AddX | SFXPixel::AddY | SFXPixel::Sub | SFXPixel::Mul | SFXPixel::Div | SFXPixel::Mod | SFXPixel::Neg


SFXPixel::AddX
Add the specified value to the X coordinate.
[ public ]
SFXPixelRef AddX(
    SInt16 param   // value to add to the X coordinate
);

Reference

SFXPixel::Add | SFXPixel::AddY | SFXPixel::SubX | SFXPixel::MulX | SFXPixel::DivX | SFXPixel::ModX | SFXPixel::NegX


SFXPixel::AddY
Add the specified value to the Y coordinate.
[ public ]
SFXPixelRef AddY(
    SInt16 param   // value to add to the Y coordinate
);

Reference

SFXPixel::Add | SFXPixel::AddX | SFXPixel::SubY | SFXPixel::MulY | SFXPixel::DivY | SFXPixel::ModY | SFXPixel::NegY


SFXPixel::Div
Divide the coordinates by the specified value.
[ public ]
SFXPixelRef Div(
    SInt16 x   // divide X coordinate by this value
    SInt16 y   // divide Y coordinate by this value
);
[ public ]
SFXPixelRef Div(
    SInt16 param   // divide the coordinates by this value
);

Description

The behaviour is not defined when the value of x, y, or param argument is 0.

Reference

SFXPixel::Add | SFXPixel::Sub | SFXPixel::Mul | SFXPixel::DivX | SFXPixel::DivY | SFXPixel::Mod | SFXPixel::Neg | operator/ | SFXPixel::operator/=


SFXPixel::DivX
Divide the X coordinate by the specified value.
[ public ]
SFXPixelRef DivX(
    SInt16 param   // divide X coordinate by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXPixel::AddX | SFXPixel::SubX | SFXPixel::MulX | SFXPixel::Div | SFXPixel::DivY | SFXPixel::ModX | SFXPixel::NegX


SFXPixel::DivY
Divide the Y coordinate by the specified value.
[ public ]
SFXPixelRef DivY(
    SInt16 param   // divide Y coordinate by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXPixel::AddY | SFXPixel::SubY | SFXPixel::MulY | SFXPixel::Div | SFXPixel::DivX | SFXPixel::ModY | SFXPixel::NegY


SFXPixel::Equals
Check whether this pixel equals the specified pixel or not.
[ public, const ]
Bool Equals(
    SFXPixelConstRef param   // pixel to compare
);
[ public, const ]
Bool Equals(
    SInt16 x   // X coordinate of the pixel to compare
    SInt16 y   // Y coordinate of the pixel to compare
);

Return value

  • If yes: true
  • Otherwise: false

Reference

operator== | operator!=


SFXPixel::GetBottom
Get the Y coordinate of the bottom edge.
[ public, const ]
SInt16 GetBottom(Void);

Reference

SFXPixel::GetTop | SFXPixel::GetLeft | SFXPixel::GetRight | SFXPixel::GetLeftTop | SFXPixel::GetRightTop | SFXPixel::GetLeftBottom | SFXPixel::GetRightBottom | SFXPixel::SetBottom


SFXPixel::GetLeft
Get the X coordinate of the left edge.
[ public, const ]
SInt16 GetLeft(Void);

Reference

SFXPixel::GetTop | SFXPixel::GetBottom | SFXPixel::GetRight | SFXPixel::GetLeftTop | SFXPixel::GetRightTop | SFXPixel::GetLeftBottom | SFXPixel::GetRightBottom | SFXPixel::SetLeft


SFXPixel::GetLeftBottom
Get the coordinates of left-bottom point.
[ public, const ]
SFXGrid GetLeftBottom(Void);

Reference

SFXPixel::GetBottom | SFXPixel::GetLeft | SFXPixel::SetLeftBottom


SFXPixel::GetLeftTop
Get the coordinates of left-top point.
[ public, const ]
SFXGrid GetLeftTop(Void);

Reference

SFXPixel::GetTop | SFXPixel::GetLeft | SFXPixel::SetLeftTop


SFXPixel::GetRight
Get the X coordinate of the right edge.
[ public, const ]
SInt16 GetRight(Void);

Reference

SFXPixel::GetTop | SFXPixel::GetBottom | SFXPixel::GetLeft | SFXPixel::GetLeftTop | SFXPixel::GetRightTop | SFXPixel::GetLeftBottom | SFXPixel::GetRightBottom | SFXPixel::SetRight


SFXPixel::GetRightBottom
Get the coordinates of right-bottom point.
[ public, const ]
SFXGrid GetRightBottom(Void);

Reference

SFXPixel::GetBottom | SFXPixel::GetRight | SFXPixel::SetRightBottom


SFXPixel::GetRightTop
Get the coordinates of right-top point.
[ public, const ]
SFXGrid GetRightTop(Void);

Reference

SFXPixel::GetTop | SFXPixel::GetLeft | SFXPixel::GetRight | SFXPixel::SetRightTop


SFXPixel::GetTop
Get the Y coordinate of top edge.
[ public, const ]
SInt16 GetTop(Void);

Reference

SFXPixel::GetBottom | SFXPixel::GetLeft | SFXPixel::GetRight | SFXPixel::GetLeftTop | SFXPixel::GetRightTop | SFXPixel::GetLeftBottom | SFXPixel::GetRightBottom | SFXPixel::SetTop


SFXPixel::GetX
Get the X coordinate.
[ public, const ]
SInt16 GetX(Void);

Reference

SFXPixel::GetY | SFXPixel::SetX


SFXPixel::GetY
Get the Y coordinate.
[ public, const ]
SInt16 GetY(Void);

Reference

SFXPixel::GetX | SFXPixel::SetY


SFXPixel::IsInsideOf
Check whether this pixel is inside of the specified rectangular area or not.
[ public, const ]
Bool IsInsideOf(
    SFXRectangleConstRef param   // base rectangle
);

Return value

  • If yes: true
  • Otherwise: false

Description

The pixel with coordinates on the edge of the rectangle is also considered being inside of the rectangle.


SFXPixel::Mod
Set the coordinates to the remainder of the division of this coordinates by the specified value.
[ public ]
SFXPixelRef Mod(
    SInt16 x   // divide X coordinate by this value
    SInt16 y   // divide Y coordinate by this value
);
[ public ]
SFXPixelRef Mod(
    SInt16 param   // divide the coordinates by this value
);

Description

The behaviour is not defined when the value of x, y, or param argument is 0.

Reference

SFXPixel::Add | SFXPixel::Sub | SFXPixel::Mul | SFXPixel::Div | SFXPixel::ModX | SFXPixel::ModY | SFXPixel::Neg | operator% | SFXPixel::operator%=


SFXPixel::ModX
Set the X coordinate to the remainder of the division of X coordinate by the specified value.
[ public ]
SFXPixelRef ModX(
    SInt16 param   // divide X coordinate by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXPixel::AddX | SFXPixel::SubX | SFXPixel::MulX | SFXPixel::DivX | SFXPixel::Mod | SFXPixel::ModY | SFXPixel::NegX


SFXPixel::ModY
Set the Y coordinate to the remainder of the division of Y coordinate by the specified value.
[ public ]
SFXPixelRef ModY(
    SInt16 param   // divide Y coordinate by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXPixel::AddY | SFXPixel::SubY | SFXPixel::MulY | SFXPixel::DivY | SFXPixel::Mod | SFXPixel::ModX | SFXPixel::NegY


SFXPixel::Mul
Multiply the coordinates by the specified value.
[ public ]
SFXPixelRef Mul(
    SInt16 x   // value to multiply with the X coordinate
    SInt16 y   // value to multiply with the Y coordinate
);
[ public ]
SFXPixelRef Mul(
    SInt16 param   // value to multiply with the coordinates
);

Reference

SFXPixel::Add | SFXPixel::Sub | SFXPixel::MulX | SFXPixel::MulY | SFXPixel::Div | SFXPixel::Mod | SFXPixel::Neg | operator* | SFXPixel::operator*=


SFXPixel::MulX
Multiply the X coordinate by the specified value.
[ public ]
SFXPixelRef MulX(
    SInt16 param   // value to multiply with the X coordinate
);

Reference

SFXPixel::AddX | SFXPixel::SubX | SFXPixel::Mul | SFXPixel::MulY | SFXPixel::DivX | SFXPixel::ModX | SFXPixel::NegX


SFXPixel::MulY
Multiply the Y coordinate by the specified value.
[ public ]
SFXPixelRef MulY(
    SInt16 param   // value to multiply with the Y coordinate
);

Reference

SFXPixel::AddY | SFXPixel::SubY | SFXPixel::Mul | SFXPixel::MulX | SFXPixel::DivY | SFXPixel::ModY | SFXPixel::NegY


SFXPixel::Neg
Negate the sign of the coordinates.
[ public ]
SFXPixelRef Neg(Void);

Reference

SFXPixel::Add | SFXPixel::Sub | SFXPixel::Mul | SFXPixel::Div | SFXPixel::Mod | SFXPixel::NegX | SFXPixel::NegY


SFXPixel::NegX
Negate the sign of the X coordinate.
[ public ]
SFXPixelRef NegX(Void);

Reference

SFXPixel::AddX | SFXPixel::SubX | SFXPixel::MulX | SFXPixel::DivX | SFXPixel::ModX | SFXPixel::Neg | SFXPixel::NegY


SFXPixel::NegY
Negate the sign of the Y coordinate.
[ public ]
SFXPixelRef NegY(Void);

Reference

SFXPixel::AddY | SFXPixel::SubY | SFXPixel::MulY | SFXPixel::DivY | SFXPixel::ModY | SFXPixel::Neg | SFXPixel::NegX


SFXPixel::Offset
Add the specified value to the coordinates and move this pixel.
[ public ]
SFXPixelRef Offset(
    SFXGridConstRef param   // value to add to the coordinates
);
[ public ]
SFXPixelRef Offset(
    SInt16 x   // value to add to the X coordinate
    SInt16 y   // value to add to the Y coordinate
);

Reference

SFXPixel::Unoffset | operator- | operator+


SFXPixel::Set
Set the pixel.
[ public ]
SFXPixelRef Set(
    SFXPixelConstRef param   // pixel to set
);
[ public ]
SFXPixelRef Set(
    SInt16 x   // X coordinate to set
    SInt16 y   // Y coordinate to set
);

Reference

SFXPixel::operator=


SFXPixel::SetBottom
Set the Y coordinate of the bottom edge.
[ public ]
SFXPixelRef SetBottom(
    SInt16 param   // Y coordinate of the bottom edge to set
);

Reference

SFXPixel::GetBottom | SFXPixel::SetTop | SFXPixel::SetLeft | SFXPixel::SetRight | SFXPixel::SetLeftTop | SFXPixel::SetRightTop | SFXPixel::SetLeftBottom | SFXPixel::SetRightBottom


SFXPixel::SetLeft
Set the X coordinate of the left edge.
[ public ]
SFXPixelRef SetLeft(
    SInt16 param   // X coordinate of the left edge to set
);

Reference

SFXPixel::GetLeft | SFXPixel::SetTop | SFXPixel::SetBottom | SFXPixel::SetRight | SFXPixel::SetLeftTop | SFXPixel::SetRightTop | SFXPixel::SetLeftBottom | SFXPixel::SetRightBottom


SFXPixel::SetLeftBottom
Set the coordinates of left-bottom point.
[ public ]
SFXPixelRef SetLeftBottom(
    SFXGridConstRef param   // coordinates of left-bottom point to set
);
[ public ]
SFXPixelRef SetLeftBottom(
    SInt16 x   // X coordinate of left-bottom point to set
    SInt16 y   // Y coordinate of left-bottom point to set
);

Reference

SFXPixel::GetLeftBottom | SFXPixel::SetBottom | SFXPixel::SetLeft


SFXPixel::SetLeftTop
Set the coordinates of left-top point.
[ public ]
SFXPixelRef SetLeftTop(
    SFXGridConstRef param   // coordinates of left-top point to set
);
[ public ]
SFXPixelRef SetLeftTop(
    SInt16 x   // X coordinate of left-top point to set
    SInt16 y   // Y coordinate of left-top point to set
);

Reference

SFXPixel::GetLeftTop | SFXPixel::SetTop | SFXPixel::SetLeft


SFXPixel::SetRight
Set the X coordinate of the right edge.
[ public ]
SFXPixelRef SetRight(
    SInt16 param   // X coordinate of the right edge to set
);

Reference

SFXPixel::GetRight | SFXPixel::SetTop | SFXPixel::SetBottom | SFXPixel::SetLeft | SFXPixel::SetLeftTop | SFXPixel::SetRightTop | SFXPixel::SetLeftBottom | SFXPixel::SetRightBottom


SFXPixel::SetRightBottom
Set the coordinates of right-bottom point.
[ public ]
SFXPixelRef SetRightBottom(
    SFXGridConstRef param   // coordinates of right-bottom point to set
);
[ public ]
SFXPixelRef SetRightBottom(
    SInt16 x   // X coordinate of right-bottom point to set
    SInt16 y   // Y coordinate of right-bottom point to set
);

Reference

SFXPixel::GetRightBottom | SFXPixel::SetBottom | SFXPixel::SetRight


SFXPixel::SetRightTop
Set the coordinates of right-top point.
[ public ]
SFXPixelRef SetRightTop(
    SFXGridConstRef param   // coordinates of right-top point to set
);
[ public ]
SFXPixelRef SetRightTop(
    SInt16 x   // X coordinate of right-top point to set
    SInt16 y   // Y coordinate of right-top point to set
);

Reference

SFXPixel::GetRightTop | SFXPixel::SetTop | SFXPixel::SetLeft | SFXPixel::SetRight


SFXPixel::SetTop
Set the Y coordinate of the top edge.
[ public ]
SFXPixelRef SetTop(
    SInt16 param   // Y coordinate of the top edge to set
);

Reference

SFXPixel::GetTop | SFXPixel::SetBottom | SFXPixel::SetLeft | SFXPixel::SetRight | SFXPixel::SetLeftTop | SFXPixel::SetRightTop | SFXPixel::SetLeftBottom | SFXPixel::SetRightBottom


SFXPixel::SetX
Set the X coordinate.
[ public ]
SFXPixelRef SetX(
    SInt16 param   // X coordinate to set
);

Reference

SFXPixel::GetX | SFXPixel::Set | SFXPixel::SetY


SFXPixel::SetY
Set the Y coordinate.
[ public ]
SFXPixelRef SetY(
    SInt16 param   // Y coordinate to set
);

Reference

SFXPixel::GetY | SFXPixel::Set | SFXPixel::SetX


SFXPixel::Sub
Subtract the specified value from the coordinates.
[ public ]
SFXPixelRef Sub(
    SFXPixelConstRef param   // value to subtract from the coordinates
);
[ public ]
SFXPixelRef Sub(
    SInt16 x   // value to subtract from the X coordinate
    SInt16 y   // value to subtract from the Y coordinate
);

Reference

SFXPixel::Add | SFXPixel::SubX | SFXPixel::SubY | SFXPixel::Mul | SFXPixel::Div | SFXPixel::Mod | SFXPixel::Neg


SFXPixel::SubX
Subtract the specified value from the X coordinate.
[ public ]
SFXPixelRef SubX(
    SInt16 param   // value to subtract from the X coordinate
);

Reference

SFXPixel::AddX | SFXPixel::Sub | SFXPixel::SubY | SFXPixel::MulX | SFXPixel::DivX | SFXPixel::ModX | SFXPixel::NegX


SFXPixel::SubY
Subtract the specified value from the Y coordinate.
[ public ]
SFXPixelRef SubY(
    SInt16 param   // value to subtract from the Y coordinate
);

Reference

SFXPixel::AddY | SFXPixel::Sub | SFXPixel::SubX | SFXPixel::MulY | SFXPixel::DivY | SFXPixel::ModY | SFXPixel::NegY


SFXPixel::Unoffset
Subtract the coordinate and move this pixel.
[ public ]
SFXPixelRef Unoffset(
    SFXGridConstRef param   // value to subtract from the coordinates
);
[ public ]
SFXPixelRef Unoffset(
    SInt16 x   // value to subtract from the X coordinate
    SInt16 y   // value to subtract from the Y coordinate
);

Reference

SFXPixel::Offset | operator- | operator+


SFXPixel::ZeroInstance
Get the instance that represents 0.
[ public, static ]
SFXPixelConstRef ZeroInstance(Void);

Description

This function returns the 0 instance, which means that 0 or null is set to all the member variables of its corresponding AtomRec struct.

Example

SFXPixel pixel(10, 20);

pixel = SFXPixel::ZeroInstance();  // initialize pixel
TRACE("x = %d, y = %d", pixel.GetX(), pixel.GetY());  // x = 0, y = 0

Reference

SFXPixel::AtomRec


atomic_cast
Convert SFXPixel into SFXPixel::AtomRec.
[ public, friend ]
SFXPixel::AtomRec * atomic_cast(
    SFXPixel * param   // pixel to cast
);
[ public, friend ]
SFXPixel::AtomRec const * atomic_cast(
    SFXPixel const * param   // pixel to cast
);

Reference

SFXPixel::AtomRec


SFXPixel::operator=
Assign a pixel.
[ public ]
SFXPixelRef operator=(
    SFXPixelConstRef param   // source pixel
);

Reference

SFXPixel::Set


SFXPixel::operator/=
Divide the coordinates by the specified value.
[ public ]
SFXPixelRef operator/=(
    SInt16 param   // divide the coordinates by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXPixel::Div | operator/ | SFXPixel::operator*= | SFXPixel::operator%=


operator/
Divide the coordinates by the specified value.
[ public, friend ]
SFXPixel operator/(
    SFXPixelConstRef left   // pixel to divide
    SInt16 right            // divide the coordinates by this value
);

Description

The operation when the right is 0 has not been defined yet.

Reference

SFXPixel::Div | SFXPixel::operator/= | operator* | operator%


operator==
Check the "==" relation.
[ public, friend ]
Bool operator==(
    SFXPixelConstRef left    // pixel to compare
    SFXPixelConstRef right   // pixel to compare
);

Return value

  • If yes: true
  • Otherwise: false

Reference

SFXPixel::Equals | operator!=


SFXPixel::operator-=
Subtract the specified value from the coordinates and move this pixel.
[ public ]
SFXPixelRef operator-=(
    SFXPixelConstRef param   // value to subtract from the coordinates
);
[ public ]
SFXPixelRef operator-=(
    SFXGridConstRef param   // value to subtract from the coordinates
);

Reference

SFXPixel::Unoffset | operator- | SFXPixel::operator+=


operator-
Subtract the specified value from the coordinates and move this pixel.
[ public, const ]
SFXPixel operator-(Void);
[ public, friend ]
SFXPixel operator-(
    SFXPixelConstRef left    // pixel to move
    SFXPixelConstRef right   // value to subtract from the coordinates
);
[ public, friend ]
SFXPixel operator-(
    SFXPixelConstRef left   // pixel to move
    SFXGridConstRef right   // value to subtract from the coordinates
);

Reference

SFXPixel::Unoffset | SFXPixel::operator-= | operator+


SFXPixel::operator%=
Set the coordinates to the remainder of the division of this coordinates by the specified value.
[ public ]
SFXPixelRef operator%=(
    SInt16 param   // divide the coordinates by this value
);

Description

The behaviour is not defined when the value of param argument is 0.

Reference

SFXPixel::Mod | SFXPixel::operator/= | SFXPixel::operator*= | operator%


operator%
Set the coordinates to the remainder of the division of this coordinates by the specified value.
[ public, friend ]
SFXPixel operator%(
    SFXPixelConstRef left   // coordinates of the pixel to divide
    SInt16 right            // divide the coordinates by this value
);

Description

The operation when the right is 0 has not been defined yet.

Reference

SFXPixel::Mod | operator/ | operator* | SFXPixel::operator%=


SFXPixel::operator*=
Multiply the coordinates by the specified value.
[ public ]
SFXPixelRef operator*=(
    SInt16 param   // value to multiply with the coordinates
);

Reference

SFXPixel::Mul | SFXPixel::operator/= | operator* | SFXPixel::operator%=


operator*
Multiply the coordinates by the specified value.
[ public, friend ]
SFXPixel operator*(
    SFXPixelConstRef left   // coordinates of the pixel to multiply
    SInt16 right            // value to multiply with the coordinates
);

Reference

SFXPixel::Mul | operator/ | SFXPixel::operator*= | operator%


operator!=
Check the "!=" relation.
[ public, friend ]
Bool operator!=(
    SFXPixelConstRef left    // pixel to compare
    SFXPixelConstRef right   // pixel to compare
);

Return value

  • If yes: true
  • Otherwise: false

Reference

SFXPixel::Equals | operator==


SFXPixel::operator+=
Add the specified value to the coordinates and move this pixel.
[ public ]
SFXPixelRef operator+=(
    SFXPixelConstRef param   // value to add to the coordinates
);
[ public ]
SFXPixelRef operator+=(
    SFXGridConstRef param   // value to add to the coordinates
);

Reference

SFXPixel::Offset | SFXPixel::operator-= | operator+


operator+
Add the coordinate and move this pixel.
[ public, const ]
SFXPixel operator+(Void);
[ public, friend ]
SFXPixel operator+(
    SFXPixelConstRef left    // pixel to move
    SFXPixelConstRef right   // value to add to the coordinates
);
[ public, friend ]
SFXPixel operator+(
    SFXPixelConstRef left   // pixel to move
    SFXGridConstRef right   // value to add to the coordinates
);

Reference

SFXPixel::Offset | operator- | SFXPixel::operator+=


SFXPixel::AtomRec
Structure that represents a pixel.
struct AtomRec {
  SInt16  x;  // X coordinate
  SInt16  y;  // Y coordinate
};