Edge¶

Represents an edge.

Detailed Description¶

An edge is defined by two vertices. This structure is optimized for use with an existing indexed vertex array, so only the indices of each edge's vertex need to be provided.

Public Attributes¶

Type	Name
AmSize	m_E0 Index of the first vertex.
AmSize	m_E1 Index of the second vertex.

Public Functions¶

Type	Name
bool	operator< (const Edge & other) const Compares two edges for ordering.
bool	operator== (const Edge & other) const Checks if two edges are equal.

Public Attributes Documentation¶

m_E0

Index of the first vertex.

AmSize SparkyStudios::Audio::Amplitude::Edge::m_E0;

m_E1

Index of the second vertex.

AmSize SparkyStudios::Audio::Amplitude::Edge::m_E1;

Public Functions Documentation¶

operator<

Compares two edges for ordering.

bool Amplitude::Edge::operator< (
    const Edge & other
) const

This operator determines the ordering of two edges based on their vertex indices. It first compares the first vertex index (m_E0) of the two edges, and if they are equal, it compares the second vertex index (m_E1).

Parameters:

other The edge to compare against.

Returns:

true if this edge is considered less than the other, false otherwise.

operator==

Checks if two edges are equal.

bool Amplitude::Edge::operator== (
    const Edge & other
) const

Compares the vertex indices of two edges to determine if they are equivalent. Two edges are considered equal if both of their vertex indices are equal.

Parameters:

other The edge to compare against.

Returns:

true if the edges are equal, false otherwise.

The documentation for this struct was generated from the following file: include/SparkyStudios/Audio/Amplitude/Math/Geometry.h