Panda3D
Public Member Functions | List of all members
ConfigVariableColor Class Reference

This is a convenience class to specialize ConfigVariable as a set of floating-point types representing a color value. More...

Inheritance diagram for ConfigVariableColor:
ConfigVariable ConfigVariableBase ConfigFlags

Public Member Functions

 __init__ (const ConfigVariableColor)
 
 __init__ (str name)
 
 __init__ (str name, const LColor default_value, str description, int flags)
 
 __init__ (str name, str default_value, str description, int flags)
 
LColor getDefaultValue ()
 Returns the variable's default value. More...
 
const LColor getValue ()
 Returns the variable's value. More...
 
float operator [] (int n)
 
ConfigVariableColor operator= (const LColor value)
 
 setValue (const LColor value)
 Reassigns the variable's local value. More...
 
- Public Member Functions inherited from ConfigVariable
 __init__ (const ConfigVariable)
 
 __init__ (str name)
 Use this constructor to make a ConfigVariable of an unspecified type. More...
 
 clearValue ()
 Removes the value assigned to this variable, and lets its original value (as read from the prc files) show through. More...
 
int getNumWords ()
 Returns the number of words in the variable's value. More...
 
str getStringValue ()
 Returns the toplevel value of the variable, formatted as a string. More...
 
 setStringValue (str value)
 Changes the value assigned to this variable. More...
 
- Public Member Functions inherited from ConfigVariableBase
bool clearLocalValue ()
 Removes the local value defined for this variable, and allows its value to be once again retrieved from the .prc files. More...
 
str getDescription ()
 Returns the brief description of this variable, if it has been defined. More...
 
int getFlags ()
 Returns the flags value as set by set_flags(). More...
 
str getName ()
 Returns the name of the variable. More...
 
int getTrustLevel ()
 Returns the minimum trust_level a prc file must demonstrate in order to redefine the value for this variable. More...
 
ConfigFlags::ValueType getValueType ()
 Returns the stated type of this variable. More...
 
bool hasLocalValue ()
 Returns true if this variable's value has been shadowed by a local assignment (as created via make_local_value()), or false otherwise. More...
 
bool hasValue ()
 Returns true if this variable has an explicit value, either from a prc file or locally set, or false if variable has its default value. More...
 
bool isClosed ()
 Returns true if the variable is not trusted by any prc file (and hence cannot be modified from its compiled-in default value), or false for the normal case, in which the variable can be modified by any prc file at or above its trust level (see get_trust_level()). More...
 
bool isDynamic ()
 Returns true if the variable was indicated as "dynamic" by its constructor, indicating that its name was dynamically generated, possibly from a large pool, and it should not be listed along with the other variables. More...
 
 output (Ostream out)
 
 write (Ostream out)
 
- Public Member Functions inherited from ConfigFlags
 __init__ ()
 
 __init__ (const ConfigFlags)
 

Additional Inherited Members

- Public Types inherited from ConfigFlags
enum  ValueType {
  VT_undefined = 0, VT_list = 1, VT_string = 2, VT_filename = 3,
  VT_bool = 4, VT_int = 5, VT_double = 6, VT_enum = 7,
  VT_search_path = 8, VT_int64 = 9, VT_color = 10
}
 
enum  VariableFlags {
  F_trust_level_mask = 4095, F_open = 4096, F_closed = 8192, F_dynamic = 16384,
  F_dconfig = 32768
}
 
- Public Attributes inherited from ConfigVariableBase
bool closed
 Returns true if the variable is not trusted by any prc file (and hence cannot be modified from its compiled-in default value), or false for the normal case, in which the variable can be modified by any prc file at or above its trust level (see get_trust_level()). More...
 
const String description
 Returns the brief description of this variable, if it has been defined. More...
 
bool dynamic
 Returns true if the variable was indicated as "dynamic" by its constructor, indicating that its name was dynamically generated, possibly from a large pool, and it should not be listed along with the other variables. More...
 
const String name
 Returns the name of the variable. More...
 
int trust_level
 Returns the minimum trust_level a prc file must demonstrate in order to redefine the value for this variable. More...
 
ConfigFlags::ValueType value_type
 Returns the stated type of this variable. More...
 

Detailed Description

This is a convenience class to specialize ConfigVariable as a set of floating-point types representing a color value.

It interprets the color differently depending on how many words were specified: if only one, it is interpreted as a shade of gray with alpha 1. If two values were specified, a grayscale and alpha pair. If three, a set of R, G, B values with alpha 1, and if four, a complete RGBA color.

This isn't defined in dtool because it relies on the LColor class, which is defined in linmath.

Member Function Documentation

◆ __init__() [1/4]

__init__ ( const  ConfigVariableColor)

◆ __init__() [2/4]

__init__ ( str  name)

◆ __init__() [3/4]

__init__ ( str  name,
const LColor  default_value,
str  description,
int  flags 
)

◆ __init__() [4/4]

__init__ ( str  name,
str  default_value,
str  description,
int  flags 
)

◆ getDefaultValue()

LColor getDefaultValue ( )

Returns the variable's default value.

◆ getValue()

const LColor getValue ( )

Returns the variable's value.

◆ operator []()

float operator [] ( int  n)

◆ operator=()

ConfigVariableColor operator= ( const LColor  value)

◆ setValue()

setValue ( const LColor  value)

Reassigns the variable's local value.