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.

See also

• The Theory chapter of the Shape TK manual.

• OEColorForceFieldLegendDisplayOptions class

• OEDrawColorForceFieldLegend function

Example of depicting a color force field in a legend

Code Example

• Visualizing Shape and Color Overlap OpenEye Python Cookbook recipe

Constructors

OEColorForceFieldDisplay(cff: OEColorForceField,
                         preserveQueryColors: bool = False) -> OEColorForceFieldDisplay

Creates an OEColorForceFieldDisplay object with a given color force field and an option to preserve colors on input query molecules.

OEColorForceFieldDisplay(rhs: OEColorForceFieldDisplay) -> OEColorForceFieldDisplay

Copy constructor.

GetColor

GetColor(type: int) -> OEColor

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

GetColorTypes

GetColorTypes() -> Iterable[int]

Returns the iterator over the color atom types.

GetName

GetName(type: int) -> str

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

NumColorTypes

NumColorTypes() -> int

Returns the number of color atom types.

SetColor

SetColor(type: int, color: OEColor) -> None

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

SetName

SetName(type: int, name: str) -> None

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