class HT_Option
Objects of this class specify the option definition and a particular value for the option. An option is a pair of a definition as well as a value. The definition specifies the name and type of the option as well as the count and scope of the values of the option. The value specifies the current setting of the option and contains an array of one or more values of a given type. See Also HT_Option_Defintion, HT_Option_Table, HT_Option_Value, HT_Option_Enum Methods 
definition
Returns a copy of the definition of the option. 
inherit
Sets the value of the option, only if the option’s value has not been previously set. 
is_global
Sets the option’s definition scope to be global. 
is_local
Sets the option’s definition scope to be local. 
is_set
Indicates whether or not the value of the option has ever been set. 
name
Returns the option’s definition name. 
set
Sets the value of the option. 
type
Returns the option’s definition type. 
unset
Resets the value of the option. 
value
Returns a pointer to the value of the option. Constructor 
HT_Option
Creates an option object.
HT_Option::definition

Purpose

Returns a copy of the definition of the option. Synopsis 
HT_Option_Definition definition()
 Details A copy of the definition of the option is made and returned. See Also
HT_Option_Definition
HT_Option::HT_Option

Purpose

Creates an option object. Synopsis 
HT_Option (HT_Option_Definition const & def) alter
HT_Option (HT_Option_Definition const & def, 
    HT_Option_Value const & val) alter
HT_Option (HT_String const & name, HT_Otion_Enum:: Scope scope, 
    double v0) alter
HT_Option (HT_String const & name, HT_Otion_Enum:: Scope scope, 
    double v0, double v1) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    HT_Boolean v0) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    int v0) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    int v0, int v1) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    int v0, int v1, int v2) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    int v0, int v1, int v2, int v3) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope,
    int v0, int v1, int v2, int v3, int v4, int v5) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    long v0) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    float v0) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    float v0, float v1)
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    float v0, float v1, float v2) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    float v0, float v1, float v2, float v3) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope,
    float v0, float v1, float v2, float v3, float v4, float v5) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    HT_String const & v0) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    HT_Palette const & v0) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    void const * v0) alter
HT_Option (HT_String const & name, HT_Option_Enum::Scope scope, 
    HT_Aggregate_Option const & v0) alter
 Details Creates an option object. The first form creates an option object given just a definition. In this case, the value of the option is left unset. The rest of the constructors create an option object given a definition name, the scope and a variety of values ranging from a single integer to an HT_Aggregate_Option; the option value is marked as set. The HT_Option_Enum::Scope indicates whether the option propagates to the rest of the stacked renderer pipeline, that is, HT_Option_Enum::global or  HT_Option_Enum::local.
HT_Option::inherit

Purpose

Sets the value of the option, only if the option’s value has not been previously set. Synopsis 
void inherit(HT_Option_Value const & value)
 Details This method checks to see if the value of the option has ever been set. If it has been set, then no action is taken and the method returns. Otherwise, the value is copied into the option object and the method returns.
HT_Option::is_global

Purpose

Checks to see if the option’s definition scope is global. Synopsis 
HT_Boolean is_global(void)
 Details An option can either be global or local. Options of global scope are inherited by descendent renderers, objects of local scope are not. This method checks to see if the definition’s scope is global.
HT_Option::is_local

Purpose

Checks to see if the option’s definition scope is local. Synopsis 
HT_Boolean is_local(void)
 Details An option can either be global or local. Options of global scope are inherited by descendent renderers, objects of local scope are not. This method checks to see if the definition’s scope is local.
HT_Option::is_set

Purpose

Indicates whether or not the value of the option has been set. Synopsis 
HT_Boolean is_set(void)
 Details If the object value has been set, then this function returns HK_True, otherwise HK_False.
HT_Option::name

Purpose

Returns the option’s definition name Synopsis 
HT_String const & is_global(void)
 Details The name of the option definition is returned.
HT_Option::set

Purpose

Sets the value of the option. Synopsis 
void set(HT_Option_Value const & value)
void set(void)
 Details The value of the option is set. In the first method, the value of the option is set to the value passed by the parameter value and the option value is marked as set. In the second method, the option is simply marked as having been set, but the option value is left unchanged.
HT_Option::type

Purpose

Returns the option’s definition type. Synopsis 
HT_Option_Enum::Type type(void)
 Details The type of the option’s definition is returned. The value is one of the enumerated values of option types, namely one of:  None, Boolean, Int, Long, Contour_Set, Float, String, Palette, Address. See Also
HT_Option_Enum


HT_Option::unset

Purpose

Resets the value of the option. Synopsis 
void unset(void)
 Details The option is marked as having not been set.
HT_Option::value

Purpose

Returns a pointer to the value of the option. Synopsis 
HT_Option_Value const & value (void)
HT_Option_Value & value (void)
 Details A pointer to the value of the option is returned. In the first method, this pointer is const and the option value cannot be modified. In the second method, a  non-const pointer is returned. See Also
HT_Option_Value