SurgSim::Graphics::VectorFieldData Struct Reference

A (mathematical) vector is represented as (X,Y,Z) associated with an optional color (R,G,B,alpha) information. More...

`#include <SurgSim/Graphics/VectorField.h>`

## Public Member Functions

bool | operator== (const VectorFieldData &rhs) const
| Compare the vectors and return true if equal; Othwise, false. More...
bool | operator!= (const VectorFieldData &rhs) const
| Compare the vectors and return true if not equal, false if equal. More...

## Public Attributes

SurgSim::Math::Vector3d | direction
| Direction (X,Y,Z) of the vector. More...
SurgSim::DataStructures::OptionalValue< SurgSim::Math::Vector4d > | color
| Color (R,G,B,alpha) of the vector (Optional) More...

## Detailed Description

A (mathematical) vector is represented as (X,Y,Z) associated with an optional color (R,G,B,alpha) information.

## Member Function Documentation

## operator!=()

bool SurgSim::Graphics::VectorFieldData::operator!= | ( | const VectorFieldData & | rhs | ) | const

inline

Compare the vectors and return true if not equal, false if equal.

Returns
  True if vector1 and rhs have different values; Otherwise, false.

## operator==()

bool SurgSim::Graphics::VectorFieldData::operator== | ( | const VectorFieldData & | rhs | ) | const

inline

Compare the vectors and return true if equal; Othwise, false.

Returns
  True if vector1 and rhs have the same value; Otherwise, false.

## Member Data Documentation

## color

SurgSim::DataStructures::OptionalValue<SurgSim::Math::Vector4d> SurgSim::Graphics::VectorFieldData::color

Color (R,G,B,alpha) of the vector (Optional)

## direction

SurgSim::Math::Vector3d SurgSim::Graphics::VectorFieldData::direction

Direction (X,Y,Z) of the vector.

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

- SurgSim/Graphics/VectorField.h