A Discrete-Event Network Simulator Home Tutorials  ▼ Docs    ▼ Develop ▼ API
ns3::Rectangle Class Reference

a 2d rectangle More...

`#include <rectangle.h>`

Public Types

enum  Side { RIGHT, LEFT, TOP, BOTTOM }

Public Member Functions

Rectangle (double _xMin, double _xMax, double _yMin, double _yMax)

Rectangle ()
Create a zero-sized rectangle located at coordinates (0.0,0.0) More...

Vector CalculateIntersection (const Vector &current, const Vector &speed) const

Side GetClosestSide (const Vector &position) const

bool IsInside (const Vector &position) const

double xMax

double xMin

double yMax

double yMin

Detailed Description

a 2d rectangle

Definition at line 33 of file rectangle.h.

Member Enumeration Documentation

 enum ns3::Rectangle::Side
Enumerator
RIGHT
LEFT
TOP
BOTTOM

Definition at line 36 of file rectangle.h.

Constructor & Destructor Documentation

 ns3::Rectangle::Rectangle ( double _xMin, double _xMax, double _yMin, double _yMax )
Parameters
 _xMin x coordinates of left boundary. _xMax x coordinates of right boundary. _yMin y coordinates of bottom boundary. _yMax y coordinates of top boundary.

Create a rectangle.

Definition at line 30 of file rectangle.cc.

 ns3::Rectangle::Rectangle ( )

Create a zero-sized rectangle located at coordinates (0.0,0.0)

Definition at line 39 of file rectangle.cc.

Member Function Documentation

 Vector ns3::Rectangle::CalculateIntersection ( const Vector & current, const Vector & speed ) const
Parameters
 current the current position speed the current speed
Returns
the intersection point between the rectangle and the current+speed vector.

This method assumes that the current position is located inside the rectangle and checks for this with an assert. This method compares only the x and y coordinates of the input position and speed. It ignores the z coordinate.

Definition at line 89 of file rectangle.cc.

References IsInside(), NS_ASSERT, ns3::Vector3D::x, xMax, xMin, ns3::Vector3D::y, yMax, and yMin.

Here is the call graph for this function:

Here is the caller graph for this function:

 Rectangle::Side ns3::Rectangle::GetClosestSide ( const Vector & position ) const
Parameters
 position the position to test.
Returns
the side of the rectangle the input position is closest to.

This method compares only the x and y coordinates of the input position. It ignores the z coordinate.

Definition at line 56 of file rectangle.cc.

References BOTTOM, LEFT, RIGHT, TOP, ns3::Vector3D::x, xMax, ns3::Vector3D::y, and yMax.

Here is the caller graph for this function:

 bool ns3::Rectangle::IsInside ( const Vector & position ) const
Parameters
 position the position to test.
Returns
true if the input position is located within the rectangle, false otherwise.

This method compares only the x and y coordinates of the input position. It ignores the z coordinate.

Definition at line 48 of file rectangle.cc.

References ns3::Vector3D::x, xMax, xMin, ns3::Vector3D::y, yMax, and yMin.

Here is the caller graph for this function:

Member Data Documentation

 double ns3::Rectangle::xMax

Definition at line 87 of file rectangle.h.

 double ns3::Rectangle::xMin

Definition at line 85 of file rectangle.h.

 double ns3::Rectangle::yMax

Definition at line 91 of file rectangle.h.

 double ns3::Rectangle::yMin

Definition at line 89 of file rectangle.h.

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