BotPath Class Reference

BotPath displays information about a recorded path taken or calculated. More...

Inheritance diagram for BotPath:

Collaboration diagram for BotPath:

Public Member Functions
	BotPath ()
void	AddNode (Vector3 node, float time)
	Adds a node to the path. More...
void	DrawPath ()
	Draws the path on screen using Draw class More...

Properties
bool	visible [get, set]
	Gets or sets a value indicating whether this BotPath is visible. More...
bool	highlight [get, set]
	Gets or sets a value indicating whether this BotPath is highlighted. When highlighted, the path is drawn in white. More...
string	csvName [get, set]
	Gets or sets the name of the csv. More...
float	distance [get, private set]
	Gets the total distance this BotPath covers. More...
Vector3	start [get]
	Gets the start of the path. More...
Vector3	end [get]
	Gets the end of the path. More...
Bounds	bounds [get, private set]
string	name [get]
Color	color [get, set]
	Gets or sets the color used in drawing the path via Draw. More...
Properties inherited from IObservable
string	name [get]
	Gets the name of the observable object More...
Bounds	bounds [get]
	Gets the bounds of the observable object (size and location) More...

Private Attributes
List< Vector3 >	_nodes
List< float >	_times

Detailed Description

BotPath displays information about a recorded path taken or calculated.

Definition at line 9 of file BotPath.cs.

Constructor & Destructor Documentation

BotPath.BotPath

(

)

Definition at line 11 of file BotPath.cs.

                     {
        _nodes = new List<Vector3>();
        _times = new List<float>();
        color = Color.blue;
        visible = true;
    }

Member Function Documentation

void BotPath.AddNode	(	Vector3	node,
		float	time
	)

Adds a node to the path.

Parameters

node	Node.
time	Time.

Definition at line 81 of file BotPath.cs.

                                                  {
        if (_nodes.Count > 1) {
            distance += Vector3.Distance(_nodes[_nodes.Count-1], node);
            
            Bounds b = new Bounds(node, Vector3.one);
            b.Encapsulate(bounds);
            bounds = b;
        }
        else {
            bounds = new Bounds(node, Vector3.one);
        }
            
        _nodes.Add(node);
        _times.Add(time);

    }

Here is the caller graph for this function:

void BotPath.DrawPath

(

)

Draws the path on screen using Draw class

Definition at line 101 of file BotPath.cs.

                           {
        Color c = highlight ? Color.white : color;
        for(int i = 1; i < _nodes.Count-1; i++) {
            Draw.Instance.Line(
                _nodes[i-1],
                _nodes[i],
                c);
        }
        if (_nodes.Count > 2) {
            // draw start node
            Draw.Instance.Cube(
                _nodes[0],
                Vector3.one * 0.25f,
                c);
            // draw end node
            Draw.Instance.Cube(
                _nodes[_nodes.Count-1],
                Vector3.one,
                c);
            Draw.Instance.Cube(
                _nodes[_nodes.Count-1],
                Vector3.one * 0.1f,
                c);
        }

    }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

List<Vector3> BotPath._nodes

private

Definition at line 73 of file BotPath.cs.

List<float> BotPath._times

private

Definition at line 74 of file BotPath.cs.

Property Documentation

Bounds BotPath.bounds

getprivate set

Definition at line 59 of file BotPath.cs.

Color BotPath.color

getset

Gets or sets the color used in drawing the path via Draw.

Definition at line 70 of file BotPath.cs.

string BotPath.csvName

getset

Gets or sets the name of the csv.

Definition at line 34 of file BotPath.cs.

float BotPath.distance

getprivate set

Gets the total distance this BotPath covers.

Definition at line 39 of file BotPath.cs.

Vector3 BotPath.end

get

Gets the end of the path.

Definition at line 53 of file BotPath.cs.

bool BotPath.highlight

getset

Gets or sets a value indicating whether this BotPath is highlighted. When highlighted, the path is drawn in white.

true if highlight; otherwise, false.

Definition at line 29 of file BotPath.cs.

string BotPath.name

get

Definition at line 63 of file BotPath.cs.

Vector3 BotPath.start

get

Gets the start of the path.

Definition at line 44 of file BotPath.cs.

bool BotPath.visible

getset

Gets or sets a value indicating whether this BotPath is visible.

true if visible; otherwise, false.

Definition at line 22 of file BotPath.cs.

---

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

• Assets/botnavsim/Scripts/BotPath.cs