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

a 3d box More...

`#include <box.h>`

## Public Types

enum  Side {
RIGHT, LEFT, TOP, BOTTOM,
UP, DOWN
}

## Public Member Functions

Box (double _xMin, double _xMax, double _yMin, double _yMax, double _zMin, double _zMax)

Box ()
Create a zero-sized box located at coordinates (0.0,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

double zMax

double zMin

## Detailed Description

a 3d box

Definition at line 33 of file box.h.

## Member Enumeration Documentation

 enum ns3::Box::Side
Enumerator
RIGHT
LEFT
TOP
BOTTOM
UP
DOWN

Definition at line 36 of file box.h.

## Constructor & Destructor Documentation

 ns3::Box::Box ( double _xMin, double _xMax, double _yMin, double _yMax, double _zMin, double _zMax )
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. _zMin z coordinates of down boundary. _zMax z coordinates of up boundary.

Create a box.

Definition at line 31 of file box.cc.

 ns3::Box::Box ( )

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

Definition at line 43 of file box.cc.

## Member Function Documentation

 Vector ns3::Box::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 cube 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 110 of file box.cc.

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

Here is the call graph for this function:

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

This method compares the x, y, and z coordinates of the input position.

Definition at line 63 of file box.cc.

References BOTTOM, DOWN, LEFT, RIGHT, TOP, UP, ns3::Vector3D::x, xMax, ns3::Vector3D::y, yMax, ns3::Vector3D::z, and zMax.

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

This method compares the x, y, and z coordinates of the input position.

Definition at line 54 of file box.cc.

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

Here is the caller graph for this function:

## Member Data Documentation

 double ns3::Box::zMax
 double ns3::Box::zMin

Definition at line 97 of file box.h.

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