LevelZ::CoordinateMatrix3D Struct Reference

#include <matrix.hpp>

Inheritance diagram for LevelZ::CoordinateMatrix3D:

Public Member Functions
	CoordinateMatrix3D (int x, int y, int z, LevelZ::Coordinate3D start)
	CoordinateMatrix3D (int minX, int maxX, int minY, int maxY, int minZ, int maxZ, LevelZ::Coordinate3D start)
std::vector< LevelZ::Coordinate3D >	getCoordinates () const
std::vector< LevelZ::Coordinate3D >::const_iterator	begin () const
std::vector< LevelZ::Coordinate3D >::const_iterator	end () const
bool	operator== (const CoordinateMatrix3D &other) const
bool	operator!= (const CoordinateMatrix3D &other) const
std::string	to_string () const
Public Member Functions inherited from LevelZ::CoordinateMatrix

Static Public Member Functions
static LevelZ::CoordinateMatrix3D	from_string (const std::string &str)

Public Attributes
int	minX
int	maxX
int	minY
int	maxY
int	minZ
int	maxZ
LevelZ::Coordinate3D	start

Detailed Description

Represents a 3D matrix of coordinates.

Constructor & Destructor Documentation

CoordinateMatrix3D() [1/2]

LevelZ::CoordinateMatrix3D::CoordinateMatrix3D ( int x, int y, int z, LevelZ::Coordinate3D start )

inline

Constructs a new CoordinateMatrix3D object with the minimum coordinates at 0.

Parameters

x	The maximum x coordinate of the matrix.
y	The maximum y coordinate of the matrix.
z	The maximum z coordinate of the matrix.
start	The starting coordinate of the matrix.

CoordinateMatrix3D() [2/2]

LevelZ::CoordinateMatrix3D::CoordinateMatrix3D ( int minX, int maxX, int minY, int maxY, int minZ, int maxZ, LevelZ::Coordinate3D start )

inline

Constructs a new CoordinateMatrix3D object with the specified minimum and maximum coordinates.

Parameters

minX	The minimum x coordinate of the matrix.
maxX	The maximum x coordinate of the matrix.
minY	The minimum y coordinate of the matrix.
maxY	The maximum y coordinate of the matrix.
minZ	The minimum z coordinate of the matrix.
maxZ	The maximum z coordinate of the matrix.
start	The starting coordinate of the matrix.

Member Function Documentation

from_string()

static LevelZ::CoordinateMatrix3D LevelZ::CoordinateMatrix3D::from_string ( const std::string & str )

inlinestatic

Converts a string to a 3D coordinate matrix.

Parameters

str	The string to convert.

Returns

The 3D coordinate matrix.

getCoordinates()

std::vector< LevelZ::Coordinate3D > LevelZ::CoordinateMatrix3D::getCoordinates ( ) const

inline

Gets the coordinates in the matrix.

Returns

The coordinates in the matrix.

operator!=()

bool LevelZ::CoordinateMatrix3D::operator!= ( const CoordinateMatrix3D & other ) const

inline

Checks if two 2D coordinate matrices are not equal.

Parameters

other

The other coordinate matrix to compare to.

Returns

true if the coordinate matrices are not equal, false otherwise.

operator==()

bool LevelZ::CoordinateMatrix3D::operator== ( const CoordinateMatrix3D & other ) const

inline

Checks if two 2D coordinate matrices are equal.

Parameters

other

The other coordinate matrix to compare to.

Returns

true if the coordinate matrices are equal, false otherwise.

to_string()

std::string LevelZ::CoordinateMatrix3D::to_string ( ) const

inlinevirtual

Converts this coordinate matrix to a string.

Returns

The string representation of the coordinate.

Implements LevelZ::CoordinateMatrix.

Member Data Documentation

maxX

int LevelZ::CoordinateMatrix3D::maxX

The maximum x coordinate of the matrix.

maxY

int LevelZ::CoordinateMatrix3D::maxY

The maximum y coordinate of the matrix.

maxZ

int LevelZ::CoordinateMatrix3D::maxZ

The maximum z coordinate of the matrix.

minX

int LevelZ::CoordinateMatrix3D::minX

The minimum x coordinate of the matrix.

minY

int LevelZ::CoordinateMatrix3D::minY

The minimum y coordinate of the matrix.

minZ

int LevelZ::CoordinateMatrix3D::minZ

The minimum z coordinate of the matrix.

start

LevelZ::Coordinate3D LevelZ::CoordinateMatrix3D::start

The starting coordinate of the matrix.

---

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

• /home/runner/work/cpp-bindings/cpp-bindings/include/levelz/matrix.hpp