.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEShape


.. meta::
   :keywords: OEColorFFParameter, ColorFFParameter


.. _OEShape_OEColorFFParameter:

.. oe:class:: OEColorFFParameter

   .. oe:api::

      class OEColorFFParameter : public OESystem::OEMultiParameter<OEShape::OEColorForceField>

   The :ref:`OEColorFFParameter <OEShape_OEColorFFParameter>` represents parameter that has a value of type
   :ref:`OEColorForceField <OEShape_OEColorForceField>`.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   Following methods are publicly inherited from :ref:`OEMultiParameter <OESystem_OEMultiParameter>`:
    * :oe:meth:`AddLegalEntry<OESystem::OEMultiParameter::AddLegalEntry>` 
    * :oe:meth:`GetDefault<OESystem::OEMultiParameter::GetDefault>` and
      :oe:meth:`SetDefault<OESystem::OEMultiParameter::SetDefault>` 
    * :oe:meth:`GetSetting<OESystem::OEMultiParameter::GetSetting>`
    * :oe:meth:`GetValue<OESystem::OEMultiParameter::GetValue>` and
      :oe:meth:`SetValue<OESystem::OEMultiParameter::SetValue>`


   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEColorFFParameter(const std::string& name, const bool load = true)
            OEColorFFParameter()
            OEColorFFParameter(const OEColorFFParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEColorFFParameter(name: str, load: bool = True) -> OEColorFFParameter
            OEColorFFParameter() -> OEColorFFParameter
            OEColorFFParameter(arg2: OEColorFFParameter) -> OEColorFFParameter

      Default and copy constructors.

      Constructs an :ref:`OEColorFFParameter <OEShape_OEColorFFParameter>` instance using the specified set of parameters.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEColorFFParameter &operator=(const OEColorFFParameter &)

      The assignment operator.

      Assignment operator.

