inet::Coord Class Reference

Class for storing 3D coordinates. More...

#include <Coord.h>

Inheritance diagram for inet::Coord:

Public Member Functions
	Coord ()
	Default constructor. More...
	Coord (double x, double y, double z=0.0)
	Initializes a coordinate. More...
	Coord (const Coord &other)
	Initializes coordinate from other coordinate. More...
std::string	info () const override
	Returns a string with the value of the coordinate. More...
Coord &	operator*= (double f)
	Multiplies this coordinate vector by a real number. More...
Coord &	operator/= (double f)
	Divides this coordinate vector by a real number. More...
Coord &	operator+= (const Coord &a)
	Adds coordinate vector 'a' to this. More...
float	operator* (const Coord &v) const
	Dot product. More...
Coord	operator% (const Coord &v) const
	Cross product. More...
Coord &	operator= (const Coord &other)
	Assigns coordinate vector 'other' to this. More...
Coord &	operator-= (const Coord &a)
	Subtracts coordinate vector 'a' from this. More...
double	distance (const Coord &a) const
	Returns the distance to Coord 'a'. More...
double	sqrdist (const Coord &a) const
	Returns distance^2 to Coord 'a' (omits calling square root). More...
double	sqrTorusDist (const Coord &b, const Coord &size) const
	Returns the squared distance on a torus of this to Coord 'b' (omits calling square root). More...
double	squareLength () const
	Returns the square of the length of this Coords position vector. More...
double	length () const
	Returns the length of this Coords position vector. More...
void	normalize ()
	Updates the length of this position vector to be 1. More...
bool	isInBoundary (const Coord &lowerBound, const Coord &upperBound) const
	Checks if this coordinate is inside a specified rectangle. More...
bool	isNil () const
bool	isUnspecified () const
	Returns true if this coordinate is unspecified. More...
Coord	min (const Coord &a)
	Returns the minimal coordinates. More...
Coord	max (const Coord &a)
	Returns the maximal coordinates. More...
double	angle (const Coord &a)
	Returns the angle between the two vectors. More...

Public Attributes
x, y and z coordinate of the position.
double	x
double	y
double	z

Static Public Attributes
static const Coord	NIL = Coord(NaN, NaN, NaN)
	Constant with all values set to 0. More...
static const Coord	ZERO = Coord(0.0, 0.0, 0.0)
static const Coord	X_AXIS = Coord(1.0, 0.0, 0.0)
static const Coord	Y_AXIS = Coord(0.0, 1.0, 0.0)
static const Coord	Z_AXIS = Coord(0.0, 0.0, 1.0)

Private Member Functions
void	copy (const Coord &other)

Friends
Coord	operator+ (const Coord &a, const Coord &b)
	Adds two coordinate vectors. More...
Coord	operator- (const Coord &a, const Coord &b)
	Subtracts two coordinate vectors. More...
Coord	operator* (const Coord &a, double f)
	Multiplies a coordinate vector by a real number. More...
Coord	operator/ (const Coord &a, double f)
	Divides a coordinate vector by a real number. More...
bool	operator== (const Coord &a, const Coord &b)
	Tests whether two coordinate vectors are equal. More...
bool	operator!= (const Coord &a, const Coord &b)
	Tests whether two coordinate vectors are not equal. More...

Detailed Description

Class for storing 3D coordinates.

Some comparison and basic arithmetic operators are implemented.

Author

Christian Frank

Constructor & Destructor Documentation

inet::Coord::Coord ( )

inline

Default constructor.

        : x(0.0), y(0.0), z(0.0) {}

inet::Coord::Coord ( double  x, double  y, double  z = 0.0  )

inline

Initializes a coordinate.

        : x(x), y(y), z(z) {}

inet::Coord::Coord ( const Coord &  other )

inline

Initializes coordinate from other coordinate.

        : cObject(other) { copy(other); }

Member Function Documentation

double inet::Coord::angle ( const Coord &  a )

inline

Returns the angle between the two vectors.

    {
        return acos(*this * a / length() / a.length());
    }

void inet::Coord::copy ( const Coord &  other )

inlineprivate

{ x = other.x; y = other.y; z = other.z; }

double inet::Coord::distance ( const Coord &  a ) const

inline

Returns the distance to Coord 'a'.

Referenced by inet::physicallayer::ConstantSpeedPropagation::computeArrival(), inet::BonnMotionMobility::computeMaxSpeed(), inet::ANSimMobility::computeMaxSpeed(), inet::physicallayer::PathLossBase::computePathLoss(), inet::physicallayer::IdealAnalogModel::computeReception(), inet::physicallayer::DimensionalAnalogModelBase::computeReceptionPower(), inet::physicallayer::TwoRayInterference::computeTwoRayInterference(), inet::visualizer::TracingObstacleLossCanvasVisualizer::createObstacleLossVisualization(), inet::TurtleMobility::executeStatement(), inet::visualizer::MediumVisualizerBase::initialize(), inet::physicallayer::RadioMedium::isInCommunicationRange(), inet::physicallayer::RadioMedium::isInInterferenceRange(), inet::LineSegment::length(), inet::visualizer::PathCanvasVisualizerBase::refreshDisplay(), inet::RandomWPMobility::setTargetPosition(), inet::Ns2MotionMobility::setTargetPosition(), and inet::MoBANCoordinator::setTargetPosition().

    {
        Coord dist(*this - a);
        return dist.length();
    }

std::string inet::Coord::info ( ) const

inlineoverride

Returns a string with the value of the coordinate.

Referenced by inet::PostureTransition::getMatrix().

{
    std::stringstream os;
    os << *this;
    return os.str();
}

bool inet::Coord::isInBoundary ( const Coord &  lowerBound, const Coord &  upperBound  ) const

inline

Checks if this coordinate is inside a specified rectangle.

Parameters

lowerBound	The upper bound of the rectangle.
upperBound	The lower bound of the rectangle.

Referenced by inet::PostureTransition::findAreaType(), and inet::MoBANCoordinator::isInsideWorld().

    {
        return lowerBound.x <= x && x <= upperBound.x &&
               lowerBound.y <= y && y <= upperBound.y &&
               lowerBound.z <= z && z <= upperBound.z;
    }

bool inet::Coord::isNil ( ) const

inline

Referenced by inet::Cuboid::computeIntersection().

    {
        return this == &NIL;
    }

bool inet::Coord::isUnspecified ( ) const

inline

Returns true if this coordinate is unspecified.

Referenced by inet::Cuboid::computeIntersection(), inet::Box::isUnspecified(), inet::Plane::isUnspecified(), and inet::LineSegment::isUnspecified().

    {
        return std::isnan(x) && std::isnan(y) && std::isnan(z);
    }

double inet::Coord::length ( ) const

inline

Returns the length of this Coords position vector.

Referenced by angle(), inet::Sphere::computeIntersection(), inet::physicallayer::AnalogModelBase::computeTransmissionDirection(), inet::visualizer::TracingObstacleLossCanvasVisualizer::createObstacleLossVisualization(), distance(), inet::Polygon::getNormalUnitVector(), inet::ConstSpeedMobility::setTargetPosition(), inet::ChiangMobility::setTargetPosition(), and inet::MoBANLocal::setTargetPosition().

{ return sqrt(squareLength()); }

Coord inet::Coord::max ( const Coord &  a )

inline

Returns the maximal coordinates.

Referenced by inet::Box::computeBoundingBox(), inet::Prism::computeBoundingBoxSize(), inet::Polyhedron::computeBoundingBoxSize(), inet::physicallayer::MediumLimitCache::computeMaxConstreaintArea(), inet::Polygon::computeSize(), and inet::visualizer::SceneVisualizerBase::getPlaygroundBounds().

    {
        return Coord(this->x > a.x ? this->x : a.x,
                this->y > a.y ? this->y : a.y,
                this->z > a.z ? this->z : a.z);
    }

Coord inet::Coord::min ( const Coord &  a )

inline

Returns the minimal coordinates.

Referenced by inet::Box::computeBoundingBox(), inet::Prism::computeBoundingBoxSize(), inet::Polyhedron::computeBoundingBoxSize(), inet::physicallayer::MediumLimitCache::computeMinConstraintArea(), and inet::Polygon::computeSize().

    {
        return Coord(this->x < a.x ? this->x : a.x,
                this->y < a.y ? this->y : a.y,
                this->z < a.z ? this->z : a.z);
    }

void inet::Coord::normalize ( )

inline

Updates the length of this position vector to be 1.

Referenced by inet::visualizer::VisualizerBase::getContactPosition(), inet::visualizer::LineManager::getLineShift(), and inet::MovingMobilityBase::moveAndUpdate().

{ *this /= length(); }

Coord inet::Coord::operator% ( const Coord &  v ) const

inline

Cross product.

    {
        return Coord(y * v.z - z * v.y, z * v.x - x * v.z, x * v.y - y * v.x);
    }

float inet::Coord::operator* ( const Coord &  v ) const

inline

Dot product.

    {
        return x * v.x + y * v.y + z * v.z;
    }

Coord& inet::Coord::operator*= ( double  f )

inline

Multiplies this coordinate vector by a real number.

    {
        x *= f;
        y *= f;
        z *= f;
        return *this;
    }

Coord& inet::Coord::operator+= ( const Coord &  a )

inline

Adds coordinate vector 'a' to this.

    {
        x += a.x;
        y += a.y;
        z += a.z;
        return *this;
    }

Coord& inet::Coord::operator-= ( const Coord &  a )

inline

Subtracts coordinate vector 'a' from this.

    {
        x -= a.x;
        y -= a.y;
        z -= a.z;
        return *this;
    }

Coord& inet::Coord::operator/= ( double  f )

inline

Divides this coordinate vector by a real number.

    {
        x /= f;
        y /= f;
        z /= f;
        return *this;
    }

Coord& inet::Coord::operator= ( const Coord &  other )

inline

Assigns coordinate vector 'other' to this.

This operator can change the dimension of the coordinate.

    {
        if (this == &other)
            return *this;
        cObject::operator=(other);
        copy(other);
        return *this;
    }

double inet::Coord::sqrdist ( const Coord &  a ) const

inline

Returns distance^2 to Coord 'a' (omits calling square root).

Referenced by inet::QuadTree::strictRangeQuery(), and inet::physicallayer::NeighborListNeighborCache::updateNeighborList().

    {
        Coord dist(*this - a);
        return dist.squareLength();
    }

double inet::Coord::sqrTorusDist	(	const Coord &	b,
		const Coord &	size
	)		const

Returns the squared distance on a torus of this to Coord 'b' (omits calling square root).

{
    double xDist = dist(x, b.x, size.x);
    double yDist = dist(y, b.y, size.y);
    double zDist = dist(z, b.z, size.z);
    return xDist * xDist + yDist * yDist + zDist * zDist;
}

double inet::Coord::squareLength ( ) const

inline

Returns the square of the length of this Coords position vector.

Referenced by sqrdist().

{ return x * x + y * y + z * z; }

Friends And Related Function Documentation

bool operator!= ( const Coord &  a, const Coord &  b  )

friend

Tests whether two coordinate vectors are not equal.

Negation of the operator==.

{ return !(a == b); }

Coord operator* ( const Coord &  a, double  f  )

friend

Multiplies a coordinate vector by a real number.

    {
        Coord tmp(a);
        tmp *= f;
        return tmp;
    }

Coord operator+ ( const Coord &  a, const Coord &  b  )

friend

Adds two coordinate vectors.

    {
        Coord tmp(a);
        tmp += b;
        return tmp;
    }

Coord operator- ( const Coord &  a, const Coord &  b  )

friend

Subtracts two coordinate vectors.

    {
        Coord tmp(a);
        tmp -= b;
        return tmp;
    }

Coord operator/ ( const Coord &  a, double  f  )

friend

Divides a coordinate vector by a real number.

    {
        Coord tmp(a);
        tmp /= f;
        return tmp;
    }

bool operator== ( const Coord &  a, const Coord &  b  )

friend

Tests whether two coordinate vectors are equal.

Because coordinates are of type double, this is done through the math::close function.

    {
        // FIXME: this implementation is not transitive
        return math::close(a.x, b.x) && math::close(a.y, b.y) && math::close(a.z, b.z);
    }

Member Data Documentation

const Coord inet::Coord::NIL = Coord(NaN, NaN, NaN)

static

Constant with all values set to 0.

Referenced by inet::Box::computeBoundingBox(), inet::Cuboid::computeIntersection(), inet::Plane::computeIntersection(), inet::Polygon::computeIntersection(), inet::Prism::computeIntersection(), inet::Polyhedron::computeIntersection(), inet::physicallayer::MediumLimitCache::computeMaxConstreaintArea(), inet::physicallayer::MediumLimitCache::computeMinConstraintArea(), inet::physicalenvironment::PhysicalEnvironment::parseObjects(), and inet::PolyhedronFace::PolyhedronFace().

double inet::Coord::x

Referenced by inet::MobilityBase::checkPosition(), inet::BVHTree::computeBoundingBox(), inet::SpatialGrid::computeBoundingVoxels(), inet::CanvasProjection::computeCanvasPoint(), inet::SpatialGrid::computeConstraintAreaSideLengths(), inet::SimpleGeographicCoordinateSystem::computeGeographicCoordinate(), inet::Cuboid::computeIntersection(), inet::BonnMotionMobility::computeMaxSpeed(), inet::SpatialGrid::computeNumberOfVoxels(), inet::physicallayer::AnalogModelBase::computeTransmissionDirection(), inet::Cuboid::computeVisibleFaces(), inet::SpatialGrid::coordToMatrixIndices(), copy(), inet::QuadTree::doesIntersectWithQuadrant(), inet::TurtleMobility::executeStatement(), inet::ANSimMobility::extractDataFrom(), inet::GPSR::findPerimeterRoutingNextHop(), inet::LinearNodeDistributionMobility::finish(), inet::Polygon::getEdgeOutwardNormalVector(), inet::Polygon::getNormalVector(), inet::MobilityBase::getRandomPosition(), inet::TurtleMobility::getValue(), inet::GPSR::getVectorAngle(), inet::physicalenvironment::GridObjectCache::initialize(), inet::RectangleMobility::initialize(), inet::physicallayer::GridNeighborCache::initialize(), inet::physicalenvironment::PhysicalEnvironment::initialize(), inet::MobilityBase::initialize(), inet::visualizer::MediumCanvasVisualizer::initialize(), inet::QuadTree::insert(), inet::SpatialGrid::insertObject(), inet::GPSR::intersectSections(), inet::BVHTree::intersectWithLineSegment(), isInBoundary(), inet::QuadTree::isInRectangleRange(), inet::Cuboid::isInsideX(), inet::MobilityBase::isOutside(), inet::visualizer::isPointOnSegment(), inet::SpatialGrid::LineSegmentIterator::LineSegmentIterator(), inet::Rotation::matrixMultiplication(), inet::Rotation::matrixTransposeMultiplication(), max(), min(), inet::VehicleMobility::move(), inet::RectangleMobility::move(), inet::CircleMobility::move(), inet::QuadTree::move(), inet::MovingMobilityBase::moveAndUpdate(), operator%(), inet::BVHTree::AxisComparator::operator()(), operator*(), operator+=(), operator-=(), inet::operator<<(), inet::physicalenvironment::PhysicalEnvironment::parseObjects(), inet::physicalenvironment::PhysicalEnvironment::parseShapes(), inet::PolyhedronPoint::PolyhedronPoint(), inet::GaussMarkovMobility::preventBorderHugging(), inet::MobilityBase::raiseErrorIfOutside(), inet::MoBANCoordinator::readConfigurationFile(), inet::VehicleMobility::readWaypointsFromFile(), inet::NetAnimTrace::receiveSignal(), inet::visualizer::MediumCanvasVisualizer::receptionStarted(), inet::MobilityBase::reflectIfOutside(), inet::visualizer::PathCanvasVisualizerBase::refreshDisplay(), inet::QuadTree::remove(), inet::QuadTree::setBoundary(), inet::StaticGridMobility::setInitialPosition(), inet::StaticConcentricMobility::setInitialPosition(), inet::VehicleMobility::setInitialPosition(), inet::BonnMotionMobility::setInitialPosition(), inet::TractorMobility::setInitialPosition(), inet::LinearNodeDistributionMobility::setInitialPosition(), inet::Ns2MotionMobility::setInitialPosition(), inet::MobilityBase::setInitialPosition(), inet::BonnMotionMobility::setTargetPosition(), inet::TractorMobility::setTargetPosition(), inet::Ns2MotionMobility::setTargetPosition(), inet::MoBANCoordinator::setTargetPosition(), inet::SpatialGrid::SpatialGrid(), sqrTorusDist(), inet::MoBANLocal::updateVisualRepresentation(), inet::QuadTree::whichQuadrant(), and inet::MobilityBase::wrapIfOutside().

const Coord inet::Coord::X_AXIS = Coord(1.0, 0.0, 0.0)

static

Referenced by inet::visualizer::LineManager::getLineShift().

double inet::Coord::y

Referenced by inet::MobilityBase::checkPosition(), inet::BVHTree::computeBoundingBox(), inet::SpatialGrid::computeBoundingVoxels(), inet::CanvasProjection::computeCanvasPoint(), inet::SpatialGrid::computeConstraintAreaSideLengths(), inet::SimpleGeographicCoordinateSystem::computeGeographicCoordinate(), inet::Cuboid::computeIntersection(), inet::BonnMotionMobility::computeMaxSpeed(), inet::SpatialGrid::computeNumberOfVoxels(), inet::physicallayer::AnalogModelBase::computeTransmissionDirection(), inet::Cuboid::computeVisibleFaces(), inet::SpatialGrid::coordToMatrixIndices(), copy(), inet::QuadTree::doesIntersectWithQuadrant(), inet::TurtleMobility::executeStatement(), inet::ANSimMobility::extractDataFrom(), inet::LinearNodeDistributionMobility::finish(), inet::Polygon::getEdgeOutwardNormalVector(), inet::Polygon::getNormalVector(), inet::MobilityBase::getRandomPosition(), inet::TurtleMobility::getValue(), inet::GPSR::getVectorAngle(), inet::physicalenvironment::GridObjectCache::initialize(), inet::RectangleMobility::initialize(), inet::physicallayer::GridNeighborCache::initialize(), inet::physicalenvironment::PhysicalEnvironment::initialize(), inet::MobilityBase::initialize(), inet::visualizer::MediumCanvasVisualizer::initialize(), inet::QuadTree::insert(), inet::SpatialGrid::insertObject(), inet::GPSR::intersectSections(), inet::BVHTree::intersectWithLineSegment(), isInBoundary(), inet::QuadTree::isInRectangleRange(), inet::Cuboid::isInsideY(), inet::MobilityBase::isOutside(), inet::visualizer::isPointOnSegment(), inet::SpatialGrid::LineSegmentIterator::LineSegmentIterator(), inet::Rotation::matrixMultiplication(), inet::Rotation::matrixTransposeMultiplication(), max(), min(), inet::VehicleMobility::move(), inet::RectangleMobility::move(), inet::CircleMobility::move(), inet::QuadTree::move(), inet::MovingMobilityBase::moveAndUpdate(), operator%(), inet::BVHTree::AxisComparator::operator()(), operator*(), operator+=(), operator-=(), inet::operator<<(), inet::physicalenvironment::PhysicalEnvironment::parseObjects(), inet::physicalenvironment::PhysicalEnvironment::parseShapes(), inet::PolyhedronPoint::PolyhedronPoint(), inet::GaussMarkovMobility::preventBorderHugging(), inet::MobilityBase::raiseErrorIfOutside(), inet::MoBANCoordinator::readConfigurationFile(), inet::VehicleMobility::readWaypointsFromFile(), inet::NetAnimTrace::receiveSignal(), inet::visualizer::MediumCanvasVisualizer::receptionStarted(), inet::MobilityBase::reflectIfOutside(), inet::visualizer::PathCanvasVisualizerBase::refreshDisplay(), inet::QuadTree::remove(), inet::QuadTree::setBoundary(), inet::StaticGridMobility::setInitialPosition(), inet::StaticConcentricMobility::setInitialPosition(), inet::VehicleMobility::setInitialPosition(), inet::TractorMobility::setInitialPosition(), inet::BonnMotionMobility::setInitialPosition(), inet::LinearNodeDistributionMobility::setInitialPosition(), inet::Ns2MotionMobility::setInitialPosition(), inet::MobilityBase::setInitialPosition(), inet::BonnMotionMobility::setTargetPosition(), inet::TractorMobility::setTargetPosition(), inet::Ns2MotionMobility::setTargetPosition(), inet::MoBANCoordinator::setTargetPosition(), inet::SpatialGrid::SpatialGrid(), sqrTorusDist(), inet::MoBANLocal::updateVisualRepresentation(), inet::QuadTree::whichQuadrant(), and inet::MobilityBase::wrapIfOutside().

const Coord inet::Coord::Y_AXIS = Coord(0.0, 1.0, 0.0)

static

Referenced by inet::visualizer::LineManager::getLineShift().

double inet::Coord::z

Referenced by inet::MobilityBase::checkPosition(), inet::BVHTree::computeBoundingBox(), inet::SpatialGrid::computeBoundingVoxels(), inet::SpatialGrid::computeConstraintAreaSideLengths(), inet::SimpleGeographicCoordinateSystem::computeGeographicCoordinate(), inet::Cuboid::computeIntersection(), inet::BonnMotionMobility::computeMaxSpeed(), inet::SpatialGrid::computeNumberOfVoxels(), inet::physicallayer::AnalogModelBase::computeTransmissionDirection(), inet::physicallayer::TwoRayInterference::computeTwoRayInterference(), inet::Cuboid::computeVisibleFaces(), inet::SpatialGrid::coordToMatrixIndices(), copy(), inet::Prism::genereateFaces(), inet::Polygon::getEdgeOutwardNormalVector(), inet::Polygon::getNormalVector(), inet::MobilityBase::getRandomPosition(), inet::physicalenvironment::GridObjectCache::initialize(), inet::physicallayer::GridNeighborCache::initialize(), inet::physicalenvironment::PhysicalEnvironment::initialize(), inet::MobilityBase::initialize(), inet::QuadTree::insert(), inet::SpatialGrid::insertObject(), inet::BVHTree::intersectWithLineSegment(), isInBoundary(), inet::Cuboid::isInsideZ(), inet::MobilityBase::isOutside(), inet::SpatialGrid::LineSegmentIterator::LineSegmentIterator(), inet::Rotation::matrixMultiplication(), inet::Rotation::matrixTransposeMultiplication(), max(), min(), inet::CircleMobility::move(), inet::QuadTree::move(), inet::MovingMobilityBase::moveAndUpdate(), operator%(), inet::BVHTree::AxisComparator::operator()(), operator*(), operator+=(), operator-=(), inet::operator<<(), inet::physicalenvironment::PhysicalEnvironment::parseObjects(), inet::physicalenvironment::PhysicalEnvironment::parseShapes(), inet::PolyhedronPoint::PolyhedronPoint(), inet::MobilityBase::raiseErrorIfOutside(), inet::MoBANCoordinator::readConfigurationFile(), inet::VehicleMobility::readWaypointsFromFile(), inet::MobilityBase::reflectIfOutside(), inet::QuadTree::remove(), inet::MoBANCoordinator::selectDestination(), inet::StaticGridMobility::setInitialPosition(), inet::StaticConcentricMobility::setInitialPosition(), inet::LinearNodeDistributionMobility::setInitialPosition(), inet::MobilityBase::setInitialPosition(), inet::BonnMotionMobility::setTargetPosition(), inet::MoBANCoordinator::setTargetPosition(), inet::SpatialGrid::SpatialGrid(), sqrTorusDist(), inet::QuadTree::whichQuadrant(), and inet::MobilityBase::wrapIfOutside().

const Coord inet::Coord::Z_AXIS = Coord(0.0, 0.0, 1.0)

static

Referenced by inet::visualizer::LineManager::getLineShift().

const Coord inet::Coord::ZERO = Coord(0.0, 0.0, 0.0)

static

Referenced by inet::physicalenvironment::PhysicalEnvironment::convertPoints(), inet::visualizer::VisualizerBase::getContactPosition(), inet::StationaryMobility::getCurrentSpeed(), inet::visualizer::LineManager::getLineShift(), inet::visualizer::SceneVisualizerBase::getPlaygroundBounds(), inet::visualizer::MediumCanvasVisualizer::initialize(), inet::visualizer::SceneCanvasVisualizer::initializeAxis(), inet::LineSegmentsMobilityBase::LineSegmentsMobilityBase(), inet::MoBANLocal::MoBANLocal(), inet::physicalenvironment::PhysicalEnvironment::parseObjects(), inet::ChiangMobility::setTargetPosition(), and inet::TractorMobility::setTargetPosition().

---

The documentation for this class was generated from the following files:

• Coord.h
• Coord.cc