Class EnvironmentGraphVis

Class Documentation

class EnvironmentGraphVis

Public Functions

explicit EnvironmentGraphVis(std::shared_ptr<EnvironmentGraphVisData> data)
void setXVertexProperty(const std::string &var_name)

Set the name of the variable representing the agents x/y/z location coordinates

Note

unnecessary if the variables are named “x”, “y”, “z” respectively

Note

Implicitly calls clearXYProperty(), clearXYZProperty()

Parameters:

var_name – Name of the agent variable

Throws:

InvalidEnvProperty – If the variable is not type float[1]

void setYVertexProperty(const std::string &var_name)
void setZVertexProperty(const std::string &var_name)
void setXYVertexProperty(const std::string &var_name)

Set the name of the array variable (length 2) representing the agents x/y location coordinates

Note

Implicitly calls clearXProperty(), clearYProperty(), clearZProperty(),clearXYZProperty()

Parameters:

var_name – Name of the agent variable

Throws:

InvalidEnvProperty – If the variable is not type float[2]

void setXYZVertexProperty(const std::string &var_name)

Set the name of the array variable (length 3) representing the agents x/y/z location coordinates

Note

Implicitly calls clearXProperty(), clearYProperty(), clearZProperty(),clearXYProperty()

Parameters:

var_name – Name of the agent variable

Throws:

InvalidEnvProperty – If the variable is not type float[3]

void setColor(const Color &cf)

Set the colour the graph will be rendered

Parameters:

cf – The colour to be used, default white