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

Description

The SFXPolyline class processes the vertex coordinates as an array.

The SFXPolyline does not allocate the internal heap. It is necessary to create an array that keeps the coordinates of the vertices.

The created array should not be deleted when it is in the scope of the SFXPolyline class.

Member

Constructor/Destructor
SFXPolyline( Void )
Constructor of the SFXPolyline class.
SFXPolyline( SFXPolylineConstRef param )
Constructor of the SFXPolyline class.
SFXPolyline( SFXPixelPtr vertex , SInt16 length )
Constructor of the SFXPolyline class.
SFXPolyline( SFXPolylineConstRef polyline )
Constructor of the SFXPolyline class.
Public Functions
SFXPolylineRef AddVertex( SInt16 index , SFXPixelConstRef value )
Add the specified value to the coordinates of the specified vertex.
SFXPolylineRef AddVertex( SInt16 index , SInt16 x , SInt16 y )
Add the specified value to the coordinates of the specified vertex.
SFXPolylineRef AddVertexX( SInt16 index , SInt16 value )
Add the specified value to the X coordinate of the specified vertex.
SFXPolylineRef AddVertexY( SInt16 index , SInt16 value )
Add the specified value to the Y coordinate of the specified vertex.
SFXPolylineRef DivVertex( SInt16 index , SInt16 x , SInt16 y )
Divide the coordinates of the specified vertex by the specified value.
SFXPolylineRef DivVertex( SInt16 index , SInt16 value )
Divide the coordinates of the specified vertex by the specified value.
SFXPolylineRef DivVertexX( SInt16 index , SInt16 value )
Divide the X coordinate of the specified vertex by the specified value.
SFXPolylineRef DivVertexY( SInt16 index , SInt16 value )
Divide the Y coordinate of the specified vertex by the specified value.
Bool Equals( SFXPolylineConstRef param )
Check whether this polyline equals the specified polyline or not.
Bool Equals( SFXPixelConstPtr vertex , SInt16 length )
Check whether this polyline equals the specified polyline or not.
SInt16 GetLength( Void )
Get the number of vertices.
SFXPixelPtr GetVertex( Void )
Get the coordinates of the specified vertex.
SFXPixelConstRef GetVertex( SInt16 index )
Get the coordinates of the specified vertex.
SInt16 GetVertexX( SInt16 index )
Get the X coordinate of the specified vertex.
SInt16 GetVertexY( SInt16 index )
Get the Y coordinate of the specified vertex.
SFXPolylineRef ModVertex( SInt16 index , SInt16 x , SInt16 y )
Set the coordinates of the specified vertex to the remainder of the division of this coordinates by the specified value.
SFXPolylineRef ModVertex( SInt16 index , SInt16 value )
Set the coordinates of the specified vertex to the remainder of the division of this coordinates by the specified value.
SFXPolylineRef ModVertexX( SInt16 index , SInt16 value )
Set the X coordinate of the specified vertex to the remainder of the division of X coordinate by the specified value.
SFXPolylineRef ModVertexY( SInt16 index , SInt16 value )
Set the Y coordinate of the specified vertex to the remainder of the division of Y coordinate by the specified value.
SFXPolylineRef MulVertex( SInt16 index , SInt16 x , SInt16 y )
Multiply the coordinates of the specified vertex by the specified value.
SFXPolylineRef MulVertex( SInt16 index , SInt16 value )
Multiply the coordinates of the specified vertex by the specified value.
SFXPolylineRef MulVertexX( SInt16 index , SInt16 value )
Multiply the X coordinate of the specified vertex by the specified value.
SFXPolylineRef MulVertexY( SInt16 index , SInt16 value )
Multiply the Y coordinate of the specified vertex by the specified value.
SFXPolylineRef NegVertex( SInt16 index )
Negate the sign of the coordinates of the specified vertex.
SFXPolylineRef NegVertexX( SInt16 index )
Negate the sign of the X coordinate of the specified vertex.
SFXPolylineRef NegVertexY( SInt16 index )
Negate the sign of the Y coordinate of the specified vertex.
SFXPolylineRef Offset( SFXGridConstRef param )
Add the specified value to the coordinates of all the vertices and move this polyline.
SFXPolylineRef Offset( SInt16 x , SInt16 y )
Add the specified value to the coordinates of all the vertices and move this polyline.
SFXPolylineRef Set( SFXPolylineConstRef param )
Set the polyline.
SFXPolylineRef Set( SFXPixelPtr vertex , SInt16 length )
Set the polyline.
SFXPolylineRef Set( SFXPolylineConstRef polyline )
Set the polyline.
SFXPolylineRef SetLength( SInt16 param )
Set the number of vertices.
SFXPolylineRef SetVertex( SFXPixelPtr param )
Set the coordinates of the specified vertex (vertices).
SFXPolylineRef SetVertex( SInt16 index , SFXPixelConstRef value )
Set the coordinates of the specified vertex (vertices).
SFXPolylineRef SetVertex( SInt16 index , SInt16 x , SInt16 y )
Set the coordinates of the specified vertex (vertices).
SFXPolylineRef SetVertexX( SInt16 index , SInt16 value )
Set the X coordinate of the specified vertex.
SFXPolylineRef SetVertexY( SInt16 index , SInt16 value )
Set the Y coordinate of the specified vertex.
SFXPolylineRef SubVertex( SInt16 index , SFXPixelConstRef value )
Subtract the specified value from the coordinates of the specified vertex.
SFXPolylineRef SubVertex( SInt16 index , SInt16 x , SInt16 y )
Subtract the specified value from the coordinates of the specified vertex.
SFXPolylineRef SubVertexX( SInt16 index , SInt16 value )
Subtract the specified value from the X coordinate of the specified vertex.
SFXPolylineRef SubVertexY( SInt16 index , SInt16 value )
Subtract the specified value from the Y coordinate of the specified vertex.
SFXPolylineRef Unoffset( SFXGridConstRef param )
Subtract the specified value from the coordinates of all the vertices and move this polyline.
SFXPolylineRef Unoffset( SInt16 x , SInt16 y )
Subtract the specified value from the coordinates of all the vertices and move this polyline.
static
SFXPolylineConstRef
ZeroInstance( Void )
Get the instance that represents 0.
SFXPolylineRef operator+=( SFXGridConstRef param )
Add the specified value to the coordinates of all the vertices and move this polyline.
SFXPolylineRef operator-=( SFXGridConstRef param )
Subtract the specified value from the coordinates of all the vertices and move this polyline.
SFXPolylineRef operator=( SFXPolylineConstRef param )
Assign the polyline.
SFXPixelRef operator[]( SInt16 index )
Get the coordinates of the specified vertex.
SFXPolyline::AtomRec * atomic_cast( SFXPolyline * param )
Convert SFXPolyline into SFXPolyline::AtomRec.
SFXPolyline::AtomRec const * atomic_cast( SFXPolyline const * param )
Convert SFXPolyline into SFXPolyline::AtomRec.
AEEPolyline * interface_cast( SFXPolyline * param )
Convert the SFXPolyline into AEEPolyline.
AEEPolyline const * interface_cast( SFXPolyline const * param )
Convert the SFXPolyline into AEEPolyline.
Bool operator==( SFXPolylineConstRef left , SFXPolylineConstRef right )
Check the "==" relation.
SFXPolyline operator-( SFXPolylineConstRef left , SFXGridConstRef right )
Subtract the specified value from the coordinates of all the vertices of a polyline and move this polyline.
Bool operator!=( SFXPolylineConstRef left , SFXPolylineConstRef right )
Check the "!=" relation.
SFXPolyline operator+( SFXPolylineConstRef left , SFXGridConstRef right )
Add the specified value to the coordinates of all the vertices of a polyline and move this polyline.
Types
AtomRec
Structure that represents a polyline.
Global Functions
SFXPolyline::AtomRec * atomic_cast( SFXPolyline * param )
Convert SFXPolyline into SFXPolyline::AtomRec.
SFXPolyline::AtomRec const * atomic_cast( SFXPolyline const * param )
Convert SFXPolyline into SFXPolyline::AtomRec.
AEEPolyline * interface_cast( SFXPolyline * param )
Convert the SFXPolyline into AEEPolyline.
AEEPolyline const * interface_cast( SFXPolyline const * param )
Convert the SFXPolyline into AEEPolyline.
Bool operator==( SFXPolylineConstRef left , SFXPolylineConstRef right )
Check the "==" relation.
SFXPolyline operator-( SFXPolylineConstRef left , SFXGridConstRef right )
Subtract the specified value from the coordinates of all the vertices of a polyline and move this polyline.
Bool operator!=( SFXPolylineConstRef left , SFXPolylineConstRef right )
Check the "!=" relation.
SFXPolyline operator+( SFXPolylineConstRef left , SFXGridConstRef right )
Add the specified value to the coordinates of all the vertices of a polyline and move this polyline.

SFXPolyline::SFXPolyline
Constructor of the SFXPolyline class.
[ public, explicit ]
SFXPolyline(Void);
[ public ]
SFXPolyline(
    SFXPolylineConstRef param   // source polyline
);
[ public, explicit ]
SFXPolyline(
    SFXPixelPtr vertex   // array of vertices
    SInt16 length        // number of vertices
);
[ public, explicit ]
SFXPolyline(
    SFXPolylineConstRef polyline   // source polyline
);

SFXPolyline::AddVertex
Add the specified value to the coordinates of the specified vertex.
[ public ]
SFXPolylineRef AddVertex(
    SInt16 index             // index of the vertex
    SFXPixelConstRef value   // value to add to the coordinates of the specified vertex
);
[ public ]
SFXPolylineRef AddVertex(
    SInt16 index   // index of the vertex
    SInt16 x       // value to add to the X coordinate of the specified vertex
    SInt16 y       // value to add to the Y coordinate of the specified vertex
);

Reference

SFXPolyline::AddVertexX | SFXPolyline::AddVertexY | SFXPolyline::SubVertex | SFXPolyline::MulVertex | SFXPolyline::DivVertex | SFXPolyline::ModVertex | SFXPolyline::NegVertex


SFXPolyline::AddVertexX
Add the specified value to the X coordinate of the specified vertex.
[ public ]
SFXPolylineRef AddVertexX(
    SInt16 index   // index of the vertex
    SInt16 value   // value to add to the X coordinate of the specified vertex
);

Reference

SFXPolyline::AddVertex | SFXPolyline::AddVertexY | SFXPolyline::SubVertexX | SFXPolyline::MulVertexX | SFXPolyline::DivVertexX | SFXPolyline::ModVertexX | SFXPolyline::NegVertexX


SFXPolyline::AddVertexY
Add the specified value to the Y coordinate of the specified vertex.
[ public ]
SFXPolylineRef AddVertexY(
    SInt16 index   // index of the vertex
    SInt16 value   // value to add to the Y coordinate of the specified vertex
);

Reference

SFXPolyline::AddVertex | SFXPolyline::AddVertexX | SFXPolyline::SubVertexY | SFXPolyline::MulVertexY | SFXPolyline::DivVertexY | SFXPolyline::ModVertexY | SFXPolyline::NegVertexY


SFXPolyline::DivVertex
Divide the coordinates of the specified vertex by the specified value.
[ public ]
SFXPolylineRef DivVertex(
    SInt16 index   // index of the vertex
    SInt16 x       // divide the X coordinate of the specified vertex by this value
    SInt16 y       // divide the Y coordinate of the specified vertex by this value
);
[ public ]
SFXPolylineRef DivVertex(
    SInt16 index   // index of the vertex
    SInt16 value   // divide the coordinates of the specified vertex by this value
);

Description

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

Reference

SFXPolyline::AddVertex | SFXPolyline::SubVertex | SFXPolyline::MulVertex | SFXPolyline::DivVertexX | SFXPolyline::DivVertexY | SFXPolyline::ModVertex | SFXPolyline::NegVertex


SFXPolyline::DivVertexX
Divide the X coordinate of the specified vertex by the specified value.
[ public ]
SFXPolylineRef DivVertexX(
    SInt16 index   // index of the vertex
    SInt16 value   // divide the X coordinate of the specified vertex by this value
);

Description

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

Reference

SFXPolyline::AddVertexX | SFXPolyline::SubVertexX | SFXPolyline::MulVertexX | SFXPolyline::DivVertex | SFXPolyline::DivVertexY | SFXPolyline::ModVertexX | SFXPolyline::NegVertexX


SFXPolyline::DivVertexY
Divide the Y coordinate of the specified vertex by the specified value.
[ public ]
SFXPolylineRef DivVertexY(
    SInt16 index   // index of the vertex
    SInt16 value   // divide the Y coordinate of the specified vertex by this value
);

Description

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

Reference

SFXPolyline::AddVertexY | SFXPolyline::SubVertexY | SFXPolyline::MulVertexY | SFXPolyline::DivVertex | SFXPolyline::DivVertexX | SFXPolyline::ModVertexY | SFXPolyline::NegVertexY


SFXPolyline::Equals
Check whether this polyline equals the specified polyline or not.
[ public, const ]
Bool Equals(
    SFXPolylineConstRef param   // polyline to compare
);
[ public, const ]
Bool Equals(
    SFXPixelConstPtr vertex   // array or vertices of the polyline to compare
    SInt16 length             // number of vertices of the polyline to compare
);

Return value

  • If yes: true
  • Otherwise: false

Reference

operator== | operator!=


SFXPolyline::GetLength
Get the number of vertices.
[ public, const ]
SInt16 GetLength(Void);

Reference

SFXPolyline::SetLength


SFXPolyline::GetVertex
Get the coordinates of the specified vertex.
[ public, const ]
SFXPixelPtr GetVertex(Void);
[ public, const ]
SFXPixelConstRef GetVertex(
    SInt16 index   // index of the vertex
);

Reference

SFXPolyline::GetVertexX | SFXPolyline::GetVertexY | SFXPolyline::SetVertex


SFXPolyline::GetVertexX
Get the X coordinate of the specified vertex.
[ public, const ]
SInt16 GetVertexX(
    SInt16 index   // index of the vertex
);

Reference

SFXPolyline::GetVertex | SFXPolyline::GetVertexY | SFXPolyline::SetVertexX


SFXPolyline::GetVertexY
Get the Y coordinate of the specified vertex.
[ public, const ]
SInt16 GetVertexY(
    SInt16 index   // index of the vertex
);

Reference

SFXPolyline::GetVertex | SFXPolyline::GetVertexX | SFXPolyline::SetVertexY


SFXPolyline::ModVertex
Set the coordinates of the specified vertex to the remainder of the division of this coordinates by the specified value.
[ public ]
SFXPolylineRef ModVertex(
    SInt16 index   // index of the vertex
    SInt16 x       // divide the X coordinate of the specified vertex by this value
    SInt16 y       // divide the Y coordinate of the specified vertex by this value
);
[ public ]
SFXPolylineRef ModVertex(
    SInt16 index   // index of the vertex
    SInt16 value   // divide the coordinates of the specified vertex by this value
);

Description

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

Reference

SFXPolyline::AddVertex | SFXPolyline::SubVertex | SFXPolyline::MulVertex | SFXPolyline::DivVertex | SFXPolyline::ModVertexX | SFXPolyline::ModVertexY | SFXPolyline::NegVertex


SFXPolyline::ModVertexX
Set the X coordinate of the specified vertex to the remainder of the division of X coordinate by the specified value.
[ public ]
SFXPolylineRef ModVertexX(
    SInt16 index   // index of the vertex
    SInt16 value   // divide the X coordinate of the specified vertex by this value
);

Description

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

Reference

SFXPolyline::AddVertexX | SFXPolyline::SubVertexX | SFXPolyline::MulVertexX | SFXPolyline::DivVertexX | SFXPolyline::ModVertex | SFXPolyline::ModVertexY | SFXPolyline::NegVertexX


SFXPolyline::ModVertexY
Set the Y coordinate of the specified vertex to the remainder of the division of Y coordinate by the specified value.
[ public ]
SFXPolylineRef ModVertexY(
    SInt16 index   // index of the vertex
    SInt16 value   // divide the Y coordinate of the specified vertex by this value
);

Description

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

Reference

SFXPolyline::AddVertexY | SFXPolyline::SubVertexY | SFXPolyline::MulVertexY | SFXPolyline::DivVertexY | SFXPolyline::ModVertex | SFXPolyline::ModVertexX | SFXPolyline::NegVertexY


SFXPolyline::MulVertex
Multiply the coordinates of the specified vertex by the specified value.
[ public ]
SFXPolylineRef MulVertex(
    SInt16 index   // index of the vertex
    SInt16 x       // value to multiply with the X coordinate of the specified vertex
    SInt16 y       // value to multiply with the Y coordinate of the specified vertex
);
[ public ]
SFXPolylineRef MulVertex(
    SInt16 index   // index of the vertex
    SInt16 value   // value to multiply with the coordinates of the specified vertex
);

Reference

SFXPolyline::AddVertex | SFXPolyline::SubVertex | SFXPolyline::MulVertexX | SFXPolyline::MulVertexY | SFXPolyline::DivVertex | SFXPolyline::ModVertex | SFXPolyline::NegVertex


SFXPolyline::MulVertexX
Multiply the X coordinate of the specified vertex by the specified value.
[ public ]
SFXPolylineRef MulVertexX(
    SInt16 index   // index of the vertex
    SInt16 value   // value to multiply with the X coordinate of the specified vertex
);

Reference

SFXPolyline::AddVertexX | SFXPolyline::SubVertexX | SFXPolyline::MulVertex | SFXPolyline::MulVertexY | SFXPolyline::DivVertexX | SFXPolyline::ModVertexX | SFXPolyline::NegVertexX


SFXPolyline::MulVertexY
Multiply the Y coordinate of the specified vertex by the specified value.
[ public ]
SFXPolylineRef MulVertexY(
    SInt16 index   // index of the vertex
    SInt16 value   // value to multiply with the Y coordinate of the specified vertex
);

Reference

SFXPolyline::AddVertexY | SFXPolyline::SubVertexY | SFXPolyline::MulVertex | SFXPolyline::MulVertexX | SFXPolyline::DivVertexY | SFXPolyline::ModVertexY | SFXPolyline::NegVertexY


SFXPolyline::NegVertex
Negate the sign of the coordinates of the specified vertex.
[ public ]
SFXPolylineRef NegVertex(
    SInt16 index   // index of the vertex
);

Reference

SFXPolyline::AddVertex | SFXPolyline::SubVertex | SFXPolyline::MulVertex | SFXPolyline::DivVertex | SFXPolyline::ModVertex | SFXPolyline::NegVertexX | SFXPolyline::NegVertexY


SFXPolyline::NegVertexX
Negate the sign of the X coordinate of the specified vertex.
[ public ]
SFXPolylineRef NegVertexX(
    SInt16 index   // index of the vertex
);

Reference

SFXPolyline::AddVertexX | SFXPolyline::SubVertexX | SFXPolyline::MulVertexX | SFXPolyline::DivVertexX | SFXPolyline::ModVertexX | SFXPolyline::NegVertex | SFXPolyline::NegVertexY


SFXPolyline::NegVertexY
Negate the sign of the Y coordinate of the specified vertex.
[ public ]
SFXPolylineRef NegVertexY(
    SInt16 index   // index of the vertex
);

Reference

SFXPolyline::AddVertexY | SFXPolyline::SubVertexY | SFXPolyline::MulVertexY | SFXPolyline::DivVertexY | SFXPolyline::ModVertexY | SFXPolyline::NegVertex | SFXPolyline::NegVertexX


SFXPolyline::Offset
Add the specified value to the coordinates of all the vertices and move this polyline.
[ public ]
SFXPolylineRef Offset(
    SFXGridConstRef param   // value to add to the coordinates of all the vertices
);
[ public ]
SFXPolylineRef Offset(
    SInt16 x   // value to add to the X coordinate of all the vertices
    SInt16 y   // value to add to the Y coordinate of all the vertices
);

Reference

SFXPolyline::Unoffset | operator- | operator+


SFXPolyline::Set
Set the polyline.
[ public ]
SFXPolylineRef Set(
    SFXPolylineConstRef param   // polyline to set
);
[ public ]
SFXPolylineRef Set(
    SFXPixelPtr vertex   // array of vertices to set
    SInt16 length        // number of vertices to set
);
[ public ]
SFXPolylineRef Set(
    SFXPolylineConstRef polyline   // polyline to set
);

Reference

SFXPolyline::operator=


SFXPolyline::SetLength
Set the number of vertices.
[ public ]
SFXPolylineRef SetLength(
    SInt16 param   // number of vertices to set
);

Reference

SFXPolyline::GetLength


SFXPolyline::SetVertex
Set the coordinates of the specified vertex (vertices).
[ public ]
SFXPolylineRef SetVertex(
    SFXPixelPtr param   // array or vertices to set
);
[ public ]
SFXPolylineRef SetVertex(
    SInt16 index             // index of the vertex to set
    SFXPixelConstRef value   // coordinates to set
);
[ public ]
SFXPolylineRef SetVertex(
    SInt16 index   // index of the vertex to set
    SInt16 x       // X coordinate of the vertex to set
    SInt16 y       // Y coordinate of the vertex to set
);

Reference

SFXPolyline::GetVertex | SFXPolyline::SetVertexX | SFXPolyline::SetVertexY


SFXPolyline::SetVertexX
Set the X coordinate of the specified vertex.
[ public ]
SFXPolylineRef SetVertexX(
    SInt16 index   // index of the vertex to set
    SInt16 value   // X coordinate of the vertex to set
);

Reference

SFXPolyline::GetVertexX | SFXPolyline::SetVertex | SFXPolyline::SetVertexY


SFXPolyline::SetVertexY
Set the Y coordinate of the specified vertex.
[ public ]
SFXPolylineRef SetVertexY(
    SInt16 index   // index of the vertex to set
    SInt16 value   // Y coordinate of the vertex to set
);

Reference

SFXPolyline::GetVertexY | SFXPolyline::SetVertex | SFXPolyline::SetVertexX


SFXPolyline::SubVertex
Subtract the specified value from the coordinates of the specified vertex.
[ public ]
SFXPolylineRef SubVertex(
    SInt16 index             // index of the vertex
    SFXPixelConstRef value   // value to subtract from the coordinates of the specified vertex
);
[ public ]
SFXPolylineRef SubVertex(
    SInt16 index   // index of the vertex
    SInt16 x       // value to subtract from the X coordinate of the specified vertex
    SInt16 y       // value to subtract from the Y coordinate of the specified vertex
);

Reference

SFXPolyline::AddVertex | SFXPolyline::SubVertexX | SFXPolyline::SubVertexY | SFXPolyline::MulVertex | SFXPolyline::DivVertex | SFXPolyline::ModVertex | SFXPolyline::NegVertex


SFXPolyline::SubVertexX
Subtract the specified value from the X coordinate of the specified vertex.
[ public ]
SFXPolylineRef SubVertexX(
    SInt16 index   // index of the vertex
    SInt16 value   // value to subtract from the X coordinate of the specified vertex
);

Reference

SFXPolyline::AddVertexX | SFXPolyline::SubVertex | SFXPolyline::SubVertexY | SFXPolyline::MulVertexX | SFXPolyline::DivVertexX | SFXPolyline::ModVertexX | SFXPolyline::NegVertexX


SFXPolyline::SubVertexY
Subtract the specified value from the Y coordinate of the specified vertex.
[ public ]
SFXPolylineRef SubVertexY(
    SInt16 index   // index of the vertex
    SInt16 value   // value to subtract from the Y coordinate of the specified vertex
);

Reference

SFXPolyline::AddVertexY | SFXPolyline::SubVertex | SFXPolyline::SubVertexX | SFXPolyline::MulVertexY | SFXPolyline::DivVertexY | SFXPolyline::ModVertexY | SFXPolyline::NegVertexY


SFXPolyline::Unoffset
Subtract the specified value from the coordinates of all the vertices and move this polyline.
[ public ]
SFXPolylineRef Unoffset(
    SFXGridConstRef param   // value to subtract from the coordinates of all the vertices
);
[ public ]
SFXPolylineRef Unoffset(
    SInt16 x   // value to subtract from the X coordinate of all the vertices
    SInt16 y   // value to subtract from the Y coordinate of all the vertices
);

Reference

SFXPolyline::Offset | operator- | operator+


SFXPolyline::ZeroInstance
Get the instance that represents 0.
[ public, static ]
SFXPolylineConstRef 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 vertex[] = {
    SFXPixel(40, 40),
    SFXPixel(40, 60),
    SFXPixel(50, 30),
    SFXPixel(60, 20),
    SFXPixel(30, 30)
};

SFXPolyline polyline;

// set polyline
polyline.Set(vertex, lengthof(vertex));

// get number of vertices
TRACE("Length = %d", polyline.GetLength()); // Length = 5

// initialize polyline
polyline = SFXPolyline::ZeroInstance();

// get number of vertices
TRACE("Length = %d", polyline.GetLength());  // Length = 0

Reference

SFXPolyline::AtomRec


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

Reference

SFXPolyline::AtomRec


interface_cast
Convert the SFXPolyline into AEEPolyline.
[ public, friend ]
AEEPolyline * interface_cast(
    SFXPolyline * param   // polyline to cast
);
[ public, friend ]
AEEPolyline const * interface_cast(
    SFXPolyline const * param   // polyline to cast
);

SFXPolyline::operator=
Assign the polyline.
[ public ]
SFXPolylineRef operator=(
    SFXPolylineConstRef param   // source polyline
);

Reference

SFXPolyline::Set


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

Return value

  • If yes: true
  • Otherwise: false

Reference

SFXPolyline::Equals | operator!=


SFXPolyline::operator[]
Get the coordinates of the specified vertex.
[ public, const ]
SFXPixelRef operator[](
    SInt16 index   // index of the vertex
);

Reference

SFXPolyline::GetVertex | SFXPolyline::SetVertex


SFXPolyline::operator-=
Subtract the specified value from the coordinates of all the vertices and move this polyline.
[ public ]
SFXPolylineRef operator-=(
    SFXGridConstRef param   // value to subtract from the coordinates of all the vertices
);

Reference

SFXPolyline::Unoffset | operator- | SFXPolyline::operator+=


operator-
Subtract the specified value from the coordinates of all the vertices of a polyline and move this polyline.
[ public, friend ]
SFXPolyline operator-(
    SFXPolylineConstRef left   // polyline to move
    SFXGridConstRef right      // value to subtract from the coordinates of all the vertices of the polyline
);

Reference

SFXPolyline::Unoffset | SFXPolyline::operator-= | operator+


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

Return value

  • If yes: true
  • Otherwise: false

Reference

SFXPolyline::Equals | operator==


SFXPolyline::operator+=
Add the specified value to the coordinates of all the vertices and move this polyline.
[ public ]
SFXPolylineRef operator+=(
    SFXGridConstRef param   // value to add to the coordinates of all the vertices
);

Reference

SFXPolyline::Offset | SFXPolyline::operator-= | operator+


operator+
Add the specified value to the coordinates of all the vertices of a polyline and move this polyline.
[ public, friend ]
SFXPolyline operator+(
    SFXPolylineConstRef left   // polyline to move
    SFXGridConstRef right      // value to add to the coordinates of all the vertices of the polyline
);

Reference

SFXPolyline::Offset | operator- | SFXPolyline::operator+=


SFXPolyline::AtomRec
Structure that represents a polyline.
struct AtomRec {
  SInt16                length;  // number of vertices
  SFXPixel::AtomRecPtr  vertex;  // array of vertices
};