OEColorForceFieldDisplay

class OEColorForceFieldDisplay

This class represents OEColorForceFieldDisplay that stores the depiction information of a OEColorForceField object. See example in Figure: Example of depicting a color force field in a legend.

../../_images/DrawColorForceFieldLegend.png

Example of depicting a color force field in a legend

See also

  • The Theory chapter of the Shape TK manual.

Constructors

OEColorForceFieldDisplay(const OEShape::OEColorForceField &cff)

Creates an OEColorForceFieldDisplay object with a given color force field.

OEColorForceFieldDisplay(const OEColorForceFieldDisplay &rhs)

Copy constructor.

operator=

OEColorForceFieldDisplay &operator=(const OEColorForceFieldDisplay &rhs)

Assignment operator.

GetColor

const OESystem::OEColor &GetColor(unsigned int type) const

Returns the color that is associated with the given color atom type.

GetColorTypes

OESystem::OEIterBase<unsigned int> *GetColorTypes() const

Returns the iterator over the color atom types.

GetName

std::string GetName(unsigned int type) const

Returns the name that is associated with the given color atom type.

NumColorTypes

unsigned int NumColorTypes() const

Returns the number of color atom types.

SetColor

void SetColor(unsigned int type, const OEDepict::OEColor& color)

Sets the color that is associated with the given color atom type.

SetName

void SetName(unsigned int type, const std::string& name)

Sets the name that is associated with the given color atom type.