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

Collaboration diagram

 Collaboration diagram of SFXCircleClass

Reference

BREW API AEECircle | SFXArc | SFXPie

Member

Constructor/Destructor
SFXCircle( Void )
Constructor of the SFXCircle class.
SFXCircle( SFXCircleConstRef param )
Constructor of the SFXCircle class.
SFXCircle( SFXPixelConstRef origin , SInt16 radius )
Constructor of the SFXCircle class.
SFXCircle( SInt16 x , SInt16 y , SInt16 radius )
Constructor of the SFXCircle class.
SFXCircle( SFXPieConstRef pie )
Constructor of the SFXCircle class.
SFXCircle( SFXArcConstRef arc )
Constructor of the SFXCircle class.
Public Functions
SFXCircleRef AddOrigin( SFXPixelConstRef param )
Add the specified value to the coordinates of the center.
SFXCircleRef AddOrigin( SInt16 x , SInt16 y )
Add the specified value to the coordinates of the center.
SFXCircleRef AddRadius( SInt16 param )
Add the specified value to the radius.
SFXCircleRef AddX( SInt16 param )
Add the specified value to the X coordinate of the center.
SFXCircleRef AddY( SInt16 param )
Add the specified value to the Y coordinate of the center.
SFXCircleRef Deflate( SInt16 param )
Deflate this circle by the specified value.
SFXCircleRef DivOrigin( SInt16 x , SInt16 y )
Divide the coordinates of the center by the specified value.
SFXCircleRef DivOrigin( SInt16 param )
Divide the coordinates of the center by the specified value.
SFXCircleRef DivRadius( SInt16 param )
Divide the radius by the specified value.
SFXCircleRef DivX( SInt16 param )
Divide the X coordinate of the center by the specified value.
SFXCircleRef DivY( SInt16 param )
Divide the Y coordinate of the center by the specified value.
static
SFXCircleConstRef
EmptyInstance( Void )
Get an empty circle.
Bool Equals( SFXCircleConstRef param )
Check whether this circle equals the specified circle or not.
Bool Equals( SFXPixelConstRef origin , SInt16 radius )
Check whether this circle equals the specified circle or not.
Bool Equals( SInt16 x , SInt16 y , SInt16 radius )
Check whether this circle equals the specified circle or not.
SFXPixelConstRef GetOrigin( Void )
Get the coordinates of the center.
SInt16 GetRadius( Void )
Get the radius.
SInt16 GetX( Void )
Get the X coordinate of the center.
SInt16 GetY( Void )
Get the Y coordinate of the center.
SFXCircleRef Inflate( SInt16 param )
Inflate this circle by the specified value.
Bool IsEmpty( Void )
Check whether this circle is empty or not.
SFXCircleRef ModOrigin( SInt16 x , SInt16 y )
Set the coordinates of the center to the remainder of the division of this coordinates by the specified value.
SFXCircleRef ModOrigin( SInt16 param )
Set the coordinates of the center to the remainder of the division of this coordinates by the specified value.
SFXCircleRef ModRadius( SInt16 param )
Set the radius to the remainder of the division of this radius by the specified value.
SFXCircleRef ModX( SInt16 param )
Set the X coordinate of the center to the remainder of the division of this coordinate by the specified value.
SFXCircleRef ModY( SInt16 param )
Set the Y coordinate of the center to the remainder of the division of this coordinate by the specified value.
SFXCircleRef MulOrigin( SInt16 x , SInt16 y )
Multiply the coordinates of the center by the specified value.
SFXCircleRef MulOrigin( SInt16 param )
Multiply the coordinates of the center by the specified value.
SFXCircleRef MulRadius( SInt16 param )
Multiply the radius by the specified value.
SFXCircleRef MulX( SInt16 param )
Multiply the X coordinate of the center by the specified value.
SFXCircleRef MulY( SInt16 param )
Multiply the Y coordinate of the center by the specified value.
SFXCircleRef NegOrigin( Void )
Negate the sign of the coordinates of the center.
SFXCircleRef NegRadius( Void )
Negate the sign of the radius.
SFXCircleRef NegX( Void )
Negate the sign of X coordinate of the center.
SFXCircleRef NegY( Void )
Negate the sign of Y coordinate of the center.
SFXCircleRef Normalize( Void )
Normalize the circle.
SFXCircleRef Offset( SFXGridConstRef param )
Add the specified value to the coordinates of the center and move this circle.
SFXCircleRef Offset( SInt16 x , SInt16 y )
Add the specified value to the coordinates of the center and move this circle.
SFXCircleRef Set( SFXCircleConstRef param )
Set the circle.
SFXCircleRef Set( SFXPixelConstRef origin , SInt16 radius )
Set the circle.
SFXCircleRef Set( SInt16 x , SInt16 y , SInt16 radius )
Set the circle.
SFXCircleRef Set( SFXPieConstRef pie )
Set the circle.
SFXCircleRef Set( SFXArcConstRef arc )
Set the circle.
SFXCircleRef SetOrigin( SFXPixelConstRef param )
Set the coordinates of the center.
SFXCircleRef SetOrigin( SInt16 x , SInt16 y )
Set the coordinates of the center.
SFXCircleRef SetRadius( SInt16 param )
Set the radius.
SFXCircleRef SetX( SInt16 param )
Set X coordinate of the center.
SFXCircleRef SetY( SInt16 param )
Set Y coordinate of the center.
SFXCircleRef SubOrigin( SFXPixelConstRef param )
Subtract the specified value from the coordinates of the center.
SFXCircleRef SubOrigin( SInt16 x , SInt16 y )
Subtract the specified value from the coordinates of the center.
SFXCircleRef SubRadius( SInt16 param )
Subtract the specified value from the radius.
SFXCircleRef SubX( SInt16 param )
Subtract the specified value from the X coordinate of the center.
SFXCircleRef SubY( SInt16 param )
Subtract the specified value from the Y coordinate of the center.
SFXCircleRef Unoffset( SFXGridConstRef param )
Subtract the specified value from the coordinates of the center and move this circle
SFXCircleRef Unoffset( SInt16 x , SInt16 y )
Subtract the specified value from the coordinates of the center and move this circle
static
SFXCircleConstRef
ZeroInstance( Void )
Get the instance that represents 0.
SFXCircleRef operator+=( SFXGridConstRef param )
Add the specified value to the coordinates of the center and move this circle.
SFXCircleRef operator-=( SFXGridConstRef param )
Subtract the specified value from the coordinates of the center and move this circle.
SFXCircleRef operator=( SFXCircleConstRef param )
Assign a circle.
SFXCircle::AtomRec * atomic_cast( SFXCircle * param )
Convert SFXCircle into SFXCircle::AtomRec.
SFXCircle::AtomRec const * atomic_cast( SFXCircle const * param )
Convert SFXCircle into SFXCircle::AtomRec.
AEECircle * interface_cast( SFXCircle * param )
Convert SFXCircle into AEECircle.
AEECircle const * interface_cast( SFXCircle const * param )
Convert SFXCircle into AEECircle.
Bool operator==( SFXCircleConstRef left , SFXCircleConstRef right )
Check the "==" relation.
SFXCircle operator-( SFXCircleConstRef left , SFXGridConstRef right )
Subtract the specified value from the coordinates of the center and move this circle.
Bool operator!=( SFXCircleConstRef left , SFXCircleConstRef right )
Check the "!=" relation.
SFXCircle operator+( SFXCircleConstRef left , SFXGridConstRef right )
Add the specified value to the coordinates of the center and move this circle.
Types
AtomRec
Structure that represents a circle.
Global Functions
SFXCircle::AtomRec * atomic_cast( SFXCircle * param )
Convert SFXCircle into SFXCircle::AtomRec.
SFXCircle::AtomRec const * atomic_cast( SFXCircle const * param )
Convert SFXCircle into SFXCircle::AtomRec.
AEECircle * interface_cast( SFXCircle * param )
Convert SFXCircle into AEECircle.
AEECircle const * interface_cast( SFXCircle const * param )
Convert SFXCircle into AEECircle.
Bool operator==( SFXCircleConstRef left , SFXCircleConstRef right )
Check the "==" relation.
SFXCircle operator-( SFXCircleConstRef left , SFXGridConstRef right )
Subtract the specified value from the coordinates of the center and move this circle.
Bool operator!=( SFXCircleConstRef left , SFXCircleConstRef right )
Check the "!=" relation.
SFXCircle operator+( SFXCircleConstRef left , SFXGridConstRef right )
Add the specified value to the coordinates of the center and move this circle.

SFXCircle::SFXCircle
Constructor of the SFXCircle class.
[ public, explicit ]
SFXCircle(Void);
[ public ]
SFXCircle(
    SFXCircleConstRef param   // source SFXCircle object
);
[ public, explicit ]
SFXCircle(
    SFXPixelConstRef origin   // coordinates of the center
    SInt16 radius             // radius
);
[ public, explicit ]
SFXCircle(
    SInt16 x        // X coordinate of the center
    SInt16 y        // Y coordinate of the center
    SInt16 radius   // radius
);
[ public, explicit ]
SFXCircle(
    SFXPieConstRef pie   // source SFXPie object
);
[ public, explicit ]
SFXCircle(
    SFXArcConstRef arc   // source SFXArc object
);

Description

If the argument is specified by SFXPie class or SFXArc class, the beginning angle and the extent angle are invalid.

Reference

SFXCircle::Set | SFXCircle::SetOrigin | SFXCircle::SetRadius | SFXCircle::SetX | SFXCircle::SetY | SFXCircle::operator=


SFXCircle::AddOrigin
Add the specified value to the coordinates of the center.
[ public ]
SFXCircleRef AddOrigin(
    SFXPixelConstRef param   // value to add to the coordinates of the center
);
[ public ]
SFXCircleRef AddOrigin(
    SInt16 x   // value to add to the X coordinate of the center
    SInt16 y   // value to add to the Y coordinate of the center
);

Reference

SFXCircle::AddX | SFXCircle::AddY | SFXCircle::AddRadius | SFXCircle::SubOrigin | SFXCircle::MulOrigin | SFXCircle::DivOrigin | SFXCircle::ModOrigin | SFXCircle::NegOrigin


SFXCircle::AddRadius
Add the specified value to the radius.
[ public ]
SFXCircleRef AddRadius(
    SInt16 param   // value to add to the radius
);

Reference

SFXCircle::AddX | SFXCircle::AddY | SFXCircle::AddOrigin | SFXCircle::SubRadius | SFXCircle::MulRadius | SFXCircle::DivRadius | SFXCircle::ModRadius | SFXCircle::NegRadius


SFXCircle::AddX
Add the specified value to the X coordinate of the center.
[ public ]
SFXCircleRef AddX(
    SInt16 param   // value to add to the X coordinate of the center
);

Reference

SFXCircle::AddY | SFXCircle::AddOrigin | SFXCircle::AddRadius | SFXCircle::SubX | SFXCircle::MulX | SFXCircle::DivX | SFXCircle::ModX | SFXCircle::NegX


SFXCircle::AddY
Add the specified value to the Y coordinate of the center.
[ public ]
SFXCircleRef AddY(
    SInt16 param   // value to add to the Y coordinate of the center
);

Reference

SFXCircle::AddX | SFXCircle::AddOrigin | SFXCircle::AddRadius | SFXCircle::SubY | SFXCircle::MulY | SFXCircle::DivY | SFXCircle::ModY | SFXCircle::NegY


SFXCircle::Deflate
Deflate this circle by the specified value.
[ public ]
SFXCircleRef Deflate(
    SInt16 param   // value to subtract from the radius
);

Description

Subtract the radius, deflate the circle. The operation when the radius is 0 has not been defined yet.

Reference

SFXCircle::Inflate | SFXCircle::SubRadius


SFXCircle::DivOrigin
Divide the coordinates of the center by the specified value.
[ public ]
SFXCircleRef DivOrigin(
    SInt16 x   // divide the X coordinate of the center by this value
    SInt16 y   // divide the Y coordinate of the center by this value
);
[ public ]
SFXCircleRef DivOrigin(
    SInt16 param   // divide the coordinates of the center by this value
);

Description

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

Reference

SFXCircle::AddOrigin | SFXCircle::SubOrigin | SFXCircle::MulOrigin | SFXCircle::DivX | SFXCircle::DivY | SFXCircle::DivRadius | SFXCircle::ModOrigin | SFXCircle::NegOrigin


SFXCircle::DivRadius
Divide the radius by the specified value.
[ public ]
SFXCircleRef DivRadius(
    SInt16 param   // divide the radius by this value
);

Description

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

Reference

SFXCircle::AddRadius | SFXCircle::SubRadius | SFXCircle::MulRadius | SFXCircle::DivX | SFXCircle::DivY | SFXCircle::DivOrigin | SFXCircle::ModRadius | SFXCircle::NegRadius


SFXCircle::DivX
Divide the X coordinate of the center by the specified value.
[ public ]
SFXCircleRef DivX(
    SInt16 param   // divide the X coordinate of the center by this value
);

Description

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

Reference

SFXCircle::AddX | SFXCircle::SubX | SFXCircle::MulX | SFXCircle::DivY | SFXCircle::DivOrigin | SFXCircle::DivRadius | SFXCircle::ModX | SFXCircle::NegX


SFXCircle::DivY
Divide the Y coordinate of the center by the specified value.
[ public ]
SFXCircleRef DivY(
    SInt16 param   // divide the Y coordinate of the center by this value
);

Description

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

Reference

SFXCircle::AddY | SFXCircle::SubY | SFXCircle::MulY | SFXCircle::DivX | SFXCircle::DivOrigin | SFXCircle::DivRadius | SFXCircle::ModY | SFXCircle::NegY


SFXCircle::EmptyInstance
Get an empty circle.
[ public, static ]
SFXCircleConstRef EmptyInstance(Void);

Return value

Return an empty SFXCircle instance, which means this shape has no area.

Description

A shape has no area if the value of a length-related variable is less than or equals 0. This instance is used mainly as initial value of the assignment statement or return value of the shape-related function.


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

Return value

  • If yes: true
  • Otherwise: false

Reference

operator== | operator!=


SFXCircle::GetOrigin
Get the coordinates of the center.
[ public, const ]
SFXPixelConstRef GetOrigin(Void);

Reference

SFXCircle::GetX | SFXCircle::GetY | SFXCircle::GetRadius | SFXCircle::SetOrigin


SFXCircle::GetRadius
Get the radius.
[ public, const ]
SInt16 GetRadius(Void);

Reference

SFXCircle::GetX | SFXCircle::GetY | SFXCircle::GetOrigin | SFXCircle::SetRadius


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

Reference

SFXCircle::GetY | SFXCircle::GetOrigin | SFXCircle::GetRadius | SFXCircle::SetX


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

Reference

SFXCircle::GetX | SFXCircle::GetOrigin | SFXCircle::GetRadius | SFXCircle::SetY


SFXCircle::Inflate
Inflate this circle by the specified value.
[ public ]
SFXCircleRef Inflate(
    SInt16 param   // value to add to the radius
);

Reference

SFXCircle::Deflate | SFXCircle::AddRadius


SFXCircle::IsEmpty
Check whether this circle is empty or not.
[ public, const ]
Bool IsEmpty(Void);

Return value

  • If yes: true
  • Otherwise: false

Description

A circle is empty if its radius is less than or equal to 0.

Reference

SFXCircle::Normalize


SFXCircle::ModOrigin
Set the coordinates of the center to the remainder of the division of this coordinates by the specified value.
[ public ]
SFXCircleRef ModOrigin(
    SInt16 x   // divide X coordinate by this value
    SInt16 y   // divide Y coordinate by this value
);
[ public ]
SFXCircleRef ModOrigin(
    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

SFXCircle::AddOrigin | SFXCircle::SubOrigin | SFXCircle::MulOrigin | SFXCircle::DivOrigin | SFXCircle::ModX | SFXCircle::ModY | SFXCircle::ModRadius | SFXCircle::NegOrigin


SFXCircle::ModRadius
Set the radius to the remainder of the division of this radius by the specified value.
[ public ]
SFXCircleRef ModRadius(
    SInt16 param   // divide the radius by this value
);

Description

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

Reference

SFXCircle::AddRadius | SFXCircle::SubRadius | SFXCircle::MulRadius | SFXCircle::DivRadius | SFXCircle::ModX | SFXCircle::ModY | SFXCircle::ModOrigin | SFXCircle::NegRadius


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

Description

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

Reference

SFXCircle::AddX | SFXCircle::SubX | SFXCircle::MulX | SFXCircle::DivX | SFXCircle::ModY | SFXCircle::ModOrigin | SFXCircle::ModRadius | SFXCircle::NegX


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

Description

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

Reference

SFXCircle::AddY | SFXCircle::SubY | SFXCircle::MulY | SFXCircle::DivY | SFXCircle::ModX | SFXCircle::ModOrigin | SFXCircle::ModRadius | SFXCircle::NegY


SFXCircle::MulOrigin
Multiply the coordinates of the center by the specified value.
[ public ]
SFXCircleRef MulOrigin(
    SInt16 x   // value to mutiple with X coordinate of the center
    SInt16 y   // value to mutiple with Y coordinate of the center
);
[ public ]
SFXCircleRef MulOrigin(
    SInt16 param   // value to mutiple with the coordinates of the center
);

Reference

SFXCircle::AddOrigin | SFXCircle::SubOrigin | SFXCircle::MulX | SFXCircle::MulY | SFXCircle::MulRadius | SFXCircle::DivOrigin | SFXCircle::ModOrigin | SFXCircle::NegOrigin


SFXCircle::MulRadius
Multiply the radius by the specified value.
[ public ]
SFXCircleRef MulRadius(
    SInt16 param   // value to mutiple with the radius
);

Reference

SFXCircle::AddRadius | SFXCircle::SubRadius | SFXCircle::MulX | SFXCircle::MulY | SFXCircle::MulOrigin | SFXCircle::DivRadius | SFXCircle::ModRadius | SFXCircle::NegRadius


SFXCircle::MulX
Multiply the X coordinate of the center by the specified value.
[ public ]
SFXCircleRef MulX(
    SInt16 param   // value to mutiple with X coordinate of the center
);

Reference

SFXCircle::AddX | SFXCircle::SubX | SFXCircle::MulY | SFXCircle::MulOrigin | SFXCircle::MulRadius | SFXCircle::DivX | SFXCircle::ModX | SFXCircle::NegX


SFXCircle::MulY
Multiply the Y coordinate of the center by the specified value.
[ public ]
SFXCircleRef MulY(
    SInt16 param   // value to mutiple with Y coordinate of the center
);

Reference

SFXCircle::AddY | SFXCircle::SubY | SFXCircle::MulX | SFXCircle::MulOrigin | SFXCircle::MulRadius | SFXCircle::DivY | SFXCircle::ModY | SFXCircle::NegY


SFXCircle::NegOrigin
Negate the sign of the coordinates of the center.
[ public ]
SFXCircleRef NegOrigin(Void);

Reference

SFXCircle::AddOrigin | SFXCircle::SubOrigin | SFXCircle::MulOrigin | SFXCircle::DivOrigin | SFXCircle::ModOrigin | SFXCircle::NegX | SFXCircle::NegY | SFXCircle::NegRadius


SFXCircle::NegRadius
Negate the sign of the radius.
[ public ]
SFXCircleRef NegRadius(Void);

Reference

SFXCircle::AddRadius | SFXCircle::SubRadius | SFXCircle::MulRadius | SFXCircle::DivRadius | SFXCircle::ModRadius | SFXCircle::NegX | SFXCircle::NegY | SFXCircle::NegOrigin


SFXCircle::NegX
Negate the sign of X coordinate of the center.
[ public ]
SFXCircleRef NegX(Void);

Reference

SFXCircle::AddX | SFXCircle::SubX | SFXCircle::MulX | SFXCircle::DivX | SFXCircle::ModX | SFXCircle::NegY | SFXCircle::NegOrigin | SFXCircle::NegRadius


SFXCircle::NegY
Negate the sign of Y coordinate of the center.
[ public ]
SFXCircleRef NegY(Void);

Reference

SFXCircle::AddY | SFXCircle::SubY | SFXCircle::MulY | SFXCircle::DivY | SFXCircle::ModY | SFXCircle::NegX | SFXCircle::NegOrigin | SFXCircle::NegRadius


SFXCircle::Normalize
Normalize the circle.
[ public ]
SFXCircleRef Normalize(Void);

Description

If the radius is a positive number, do nothing.

If the radius is negative, negate its sign.

Example

SFXCircle circle(40, 50, -10);

if(circle.IsEmpty()){     // check whether the circle is empty.
                          // this function returns true since the radius is less than 0

    circle.Normalize();   // normalize the circle
}

TRACE("x = %d, y = %d, radius = %d", circle.GetX(), circle.GetY(), circle.GetRadius()); // x = 40, y = 50, radius = 10

Reference

SFXCircle::IsEmpty


SFXCircle::Offset
Add the specified value to the coordinates of the center and move this circle.
[ public ]
SFXCircleRef Offset(
    SFXGridConstRef param   // value to add to the coordinates of the center
);
[ public ]
SFXCircleRef Offset(
    SInt16 x   // value to add to X coordinate of the center
    SInt16 y   // value to add to Y coordinate of the center
);

Reference

SFXCircle::Unoffset | operator- | operator+


SFXCircle::Set
Set the circle.
[ public ]
SFXCircleRef Set(
    SFXCircleConstRef param   // circle to set
);
[ public ]
SFXCircleRef Set(
    SFXPixelConstRef origin   // coordinates of the center to set
    SInt16 radius             // radius
);
[ public ]
SFXCircleRef Set(
    SInt16 x        // X coordinate of the center to set
    SInt16 y        // Y coordinate of the center to set
    SInt16 radius   // radius to set
);
[ public ]
SFXCircleRef Set(
    SFXPieConstRef pie   // source SFXPie object to set
);
[ public ]
SFXCircleRef Set(
    SFXArcConstRef arc   // source SFXArc object to set
);

Description

If the argument is specified by the SFXPie or SFXArc class, the beginning angle and the extent angle are invalid.

Reference

SFXCircle::operator=


SFXCircle::SetOrigin
Set the coordinates of the center.
[ public ]
SFXCircleRef SetOrigin(
    SFXPixelConstRef param   // coordinates of the center to set
);
[ public ]
SFXCircleRef SetOrigin(
    SInt16 x   // X coordinate of the center to set
    SInt16 y   // Y coordinate of the center to set
);

Reference

SFXCircle::GetOrigin | SFXCircle::SetX | SFXCircle::SetY | SFXCircle::SetRadius


SFXCircle::SetRadius
Set the radius.
[ public ]
SFXCircleRef SetRadius(
    SInt16 param   // radius to set
);

Reference

SFXCircle::GetRadius | SFXCircle::SetX | SFXCircle::SetY | SFXCircle::SetOrigin


SFXCircle::SetX
Set X coordinate of the center.
[ public ]
SFXCircleRef SetX(
    SInt16 param   // X coordinate of the center to set
);

Reference

SFXCircle::GetX | SFXCircle::SetY | SFXCircle::SetOrigin | SFXCircle::SetRadius


SFXCircle::SetY
Set Y coordinate of the center.
[ public ]
SFXCircleRef SetY(
    SInt16 param   // Y coordinate of the center to set
);

Reference

SFXCircle::GetY | SFXCircle::SetX | SFXCircle::SetOrigin | SFXCircle::SetRadius


SFXCircle::SubOrigin
Subtract the specified value from the coordinates of the center.
[ public ]
SFXCircleRef SubOrigin(
    SFXPixelConstRef param   // value to subtract from thecoordinate of the center
);
[ public ]
SFXCircleRef SubOrigin(
    SInt16 x   // value to subtract from the X coordinate of the center
    SInt16 y   // value to subtract from the Y coordinate of the center
);

Reference

SFXCircle::AddOrigin | SFXCircle::SubX | SFXCircle::SubY | SFXCircle::SubRadius | SFXCircle::MulOrigin | SFXCircle::DivOrigin | SFXCircle::ModOrigin | SFXCircle::NegOrigin


SFXCircle::SubRadius
Subtract the specified value from the radius.
[ public ]
SFXCircleRef SubRadius(
    SInt16 param   // value to subtract from the radius
);

Reference

SFXCircle::AddRadius | SFXCircle::SubX | SFXCircle::SubY | SFXCircle::SubOrigin | SFXCircle::MulRadius | SFXCircle::DivRadius | SFXCircle::ModRadius | SFXCircle::NegRadius


SFXCircle::SubX
Subtract the specified value from the X coordinate of the center.
[ public ]
SFXCircleRef SubX(
    SInt16 param   // value to subtract from the X coordinate of the center
);

Reference

SFXCircle::AddX | SFXCircle::SubY | SFXCircle::SubOrigin | SFXCircle::SubRadius | SFXCircle::MulX | SFXCircle::DivX | SFXCircle::ModX | SFXCircle::NegX


SFXCircle::SubY
Subtract the specified value from the Y coordinate of the center.
[ public ]
SFXCircleRef SubY(
    SInt16 param   // value to subtract from the Y coordinate of the center
);

Reference

SFXCircle::AddY | SFXCircle::SubX | SFXCircle::SubOrigin | SFXCircle::SubRadius | SFXCircle::MulY | SFXCircle::DivY | SFXCircle::ModY | SFXCircle::NegY


SFXCircle::Unoffset
Subtract the specified value from the coordinates of the center and move this circle
[ public ]
SFXCircleRef Unoffset(
    SFXGridConstRef param   // value to subtract from the coordinates of the center
);
[ public ]
SFXCircleRef Offset(
    SInt16 x   // value to subtract from the X coordinate of the center
    SInt16 y   // value to subtract from the Y coordinate of the center
);

Reference

SFXCircle::Offset | operator- | operator+


SFXCircle::ZeroInstance
Get the instance that represents 0.
[ public, static ]
SFXCircleConstRef 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

SFXCircle circle(40, 50, 10);

circle = SFXCircle::ZeroInstance();  // initialize circle
TRACE("x = %d, y = %d, radius = %d", circle.GetX(), circle.GetY(), circle.GetRadius()); // x = 0, y = 0, radius = 0

Reference

SFXCircle::AtomRec


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

Reference

SFXCircle::AtomRec


interface_cast
Convert SFXCircle into AEECircle.
[ public, friend ]
AEECircle * interface_cast(
    SFXCircle * param   // circle to cast
);
[ public, friend ]
AEECircle const * interface_cast(
    SFXCircle const * param   // circle to cast
);

SFXCircle::operator=
Assign a circle.
[ public ]
SFXCircleRef operator=(
    SFXCircleConstRef param   // source circle
);

Reference

SFXCircle::Set


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

Return value

  • If yes: true
  • Otherwise: false

Reference

SFXCircle::Equals | operator!=


SFXCircle::operator-=
Subtract the specified value from the coordinates of the center and move this circle.
[ public ]
SFXCircleRef operator-=(
    SFXGridConstRef param   // value to subtract from the coordinates of the center
);

Reference

SFXCircle::Unoffset | operator- | SFXCircle::operator+=


operator-
Subtract the specified value from the coordinates of the center and move this circle.
[ public, friend ]
SFXCircle operator-(
    SFXCircleConstRef left   // circle to move
    SFXGridConstRef right    // value to subtract from the coordinates of the center
);

Reference

SFXCircle::Unoffset | SFXCircle::SubOrigin | SFXCircle::operator-= | operator+


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

Return value

  • If yes: true
  • Otherwise: false

Reference

SFXCircle::Equals | operator==


SFXCircle::operator+=
Add the specified value to the coordinates of the center and move this circle.
[ public ]
SFXCircleRef operator+=(
    SFXGridConstRef param   // value to add
);

Reference

SFXCircle::Offset | SFXCircle::AddOrigin | SFXCircle::operator-= | operator+


operator+
Add the specified value to the coordinates of the center and move this circle.
[ public, friend ]
SFXCircle operator+(
    SFXCircleConstRef left   // circle to move
    SFXGridConstRef right    // value to add
);

Reference

SFXCircle::Offset | operator- | SFXCircle::operator+=


SFXCircle::AtomRec
Structure that represents a circle.
struct AtomRec {
    SFXPixel::AtomRec           origin ;  // coordinates of the center
    SInt16                      radius;  // radius
};