Class MessageSpatial2D::CDescription

Nested Relationships

This class is a nested type of Class MessageSpatial2D.

Inheritance Relationships

Base Type

Derived Types

Class Documentation

class CDescription : public flamegpu::MessageBruteForce::CDescription

Subclassed by flamegpu::MessageSpatial2D::Description, flamegpu::MessageSpatial3D::CDescription

Public Functions

explicit CDescription(std::shared_ptr<Data> data)

CDescription

Constructor, creates an interface to the MessageData

Parameters

dataData store of this message’s data

explicit CDescription(std::shared_ptr<const Data> data)
CDescription(const CDescription &other_agent) = default

Copy constructor Creates a new interface to the same MessageData/ModelData

CDescription(CDescription &&other_agent) = default
CDescription &operator=(const CDescription &other_agent) = default

Assignment operator Assigns this interface to the same MessageData/ModelData

CDescription &operator=(CDescription &&other_agent) = default
bool operator==(const CDescription &rhs) const

Equality operator, checks whether message Description hierarchies are functionally the same

Note

Instead compare pointers if you wish to check that they are the same instance

Parameters

rhs – right hand side

Returns

True when messages are the same

bool operator!=(const CDescription &rhs) const

Equality operator, checks whether message Description hierarchies are functionally different

Note

Instead compare pointers if you wish to check that they are not the same instance

Parameters

rhs – right hand side

Returns

True when messages are not the same

float getRadius() const

Const accessors

float getMinX() const
float getMinY() const
float getMaxX() const
float getMaxY() const

Protected Functions

void setRadius(float r)

Accessors

void setMinX(float x)
void setMinY(float y)
void setMin(float x, float y)
void setMaxX(float x)
void setMaxY(float y)
void setMax(float x, float y)