Tramway SDK
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
tram::Path Class Reference

Base class for graphs. More...

#include <framework/path.h>

Inheritance diagram for tram::Path:
tram::Graph

Public Member Functions

 Path (name_t name)
 
void LoadFromDisk ()
 
void Draw ()
 Draws the path's line segments. More...
 

Static Public Member Functions

static PathFind (name_t name)
 Finds a path. More...
 

Protected Member Functions

 ~Path ()=delete
 

Protected Attributes

name_t name
 
std::vector< PathEdgeInfoedge_infos
 
- Protected Attributes inherited from tram::Graph
std::vector< Nodenodes
 
std::vector< Edgeedges
 

Friends

class PathFollower
 

Detailed Description

Base class for graphs.

Sequence of line segments.

This class is used as a base for Navmesh and Path.

See also
https://racenis.github.io/tram-sdk/documentation/framework/graph.html

Can be used to push an object along a path, can be used as a rail, or as a path for guiding agents.

See also
https://racenis.github.io/tram-sdk/documentation/framework/path.html

Constructor & Destructor Documentation

◆ Path()

tram::Path::Path ( name_t  name)
inline

◆ ~Path()

tram::Path::~Path ( )
protecteddelete

Member Function Documentation

◆ Draw()

void tram::Path::Draw ( )

Draws the path's line segments.

◆ Find()

Path * tram::Path::Find ( name_t  name)
static

Finds a path.

Finds a path by its name, or creates a new path by that name if not found.

Returns
Always returns a pointer to a Path.

◆ LoadFromDisk()

void tram::Path::LoadFromDisk ( )

Friends And Related Function Documentation

◆ PathFollower

friend class PathFollower
friend

Member Data Documentation

◆ edge_infos

std::vector<PathEdgeInfo> tram::Path::edge_infos
protected

◆ name

name_t tram::Path::name
protected

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