3ds Max C++ API Reference
ColorValue Class Reference

#include <colors.h>

+ Inheritance diagram for ColorValue:

Public Member Functions

 ENABLE_STACK_ALLOCATE (ColorValue)
 
ScripterExport ColorValue (AColor col)
 
ScripterExport ColorValue (Color col)
 
ScripterExport ColorValue (COLORREF col)
 
ScripterExport ColorValue (BMM_Color_64 &col)
 
ScripterExport ColorValue (Point3 col)
 
ScripterExport ColorValue (Point3Value *col)
 
ScripterExport ColorValue (float r, float g, float b, float a=1.0f)
 
ScripterExport ~ColorValue ()
 
 classof_methods (ColorValue, Value)
 
void collect ()
 
ScripterExport void sprin1 (CharStream *s)
 
 def_generic (coerce, "coerce")
 
 def_generic (copy, "copy")
 
 def_property (red)
 
 def_local_prop_alias (r, red)
 
 def_property (green)
 
 def_local_prop_alias (g, green)
 
 def_property (blue)
 
 def_local_prop_alias (b, blue)
 
 def_property (alpha)
 
 def_local_prop_alias (a, alpha)
 
 def_property (hue)
 
 def_local_prop_alias (h, hue)
 
 def_property (saturation)
 
 def_local_prop_alias (s, saturation)
 
 def_property (value)
 
 def_local_prop_alias (v, value)
 
AColor to_acolor ()
 
Color to_color ()
 
COLORREF to_colorref ()
 
Point3 to_point3 ()
 
Point4 to_point4 ()
 
void to_fpvalue (FPValue &v)
 
IOResult Save (ISave *isave)
 
- Public Member Functions inherited from Value
virtual ScripterExport BOOL is_kind_of (ValueMetaClass *c)
 
virtual ScripterExport ValueMetaClass * local_base_class ()
 
virtual Value * eval ()
 
virtual Value * eval_no_wrapper ()
 
virtual ScripterExport Value * apply (Value **arglist, int count, CallContext *cc=NULL)
 
virtual ScripterExport Value * apply_no_alloc_frame (Value **arglist, int count, CallContext *cc=NULL)
 
virtual void export_to_scripter ()
 
virtual Value * map (node_map &m)
 
virtual Value * map_path (PathName *path, node_map &m)
 
virtual Value * find_first (BOOL(*test_fn)(INode *node, int level, const void *arg), const void *test_arg)
 
virtual Value * get_path (PathName *path)
 
virtual ScripterExport void sprint (CharStream *stream)
 
virtual void prin1 ()
 
virtual void print ()
 
virtual ScripterExport Class_ID get_max_class_id ()
 
virtual ScripterExport Value * delete_vf (Value **arglist, int arg_count)
 
virtual ScripterExport Value * clearSelection_vf (Value **arglist, int arg_count)
 
virtual float to_float ()
 
virtual double to_double ()
 
virtual const MCHAR * to_string ()
 
virtual MSTR to_mstr ()
 
virtual MSTR to_filename ()
 
virtual int to_int ()
 
virtual INT64 to_int64 ()
 
virtual INT_PTR to_intptr ()
 
virtual BOOL to_bool ()
 
virtual BitArray & to_bitarray ()
 
virtual Point2 to_point2 ()
 
virtual INode * to_node ()
 
virtual Ray to_ray ()
 
virtual Interval to_interval ()
 
virtual Quat to_quat ()
 
virtual AngAxis to_angaxis ()
 
virtual Matrix3 & to_matrix3 ()
 
virtual Box3 to_box3 ()
 
virtual float * to_eulerangles ()
 
virtual Mtl * to_mtl ()
 
virtual Texmap * to_texmap ()
 
virtual MtlBase * to_mtlbase ()
 
virtual Modifier * to_modifier ()
 
virtual TimeValue to_timevalue ()
 
virtual Control * to_controller ()
 
virtual Atmospheric * to_atmospheric ()
 
virtual Effect * to_effect ()
 
virtual IMultiPassCameraEffect * to_mpassCamEffect ()
 
virtual ShadowType * to_shadowtype ()
 
virtual FilterKernel * to_filter ()
 
virtual INode * to_rootnode ()
 
virtual ITrackViewNode * to_trackviewnode ()
 
virtual NURBSIndependentPoint * to_nurbsindependentpoint ()
 
virtual NURBSPoint * to_nurbspoint ()
 
virtual NURBSObject * to_nurbsobject ()
 
virtual NURBSControlVertex * to_nurbscontrolvertex ()
 
virtual NURBSCurve * to_nurbscurve ()
 
virtual NURBSCVCurve * to_nurbscvcurve ()
 
virtual NURBSSurface * to_nurbssurface ()
 
virtual NURBSTexturePoint * to_nurbstexturepoint ()
 
virtual NURBSSet * to_nurbsset ()
 
virtual ReferenceTarget * to_reftarg ()
 
virtual Mesh * to_mesh ()
 
virtual BezierShape * to_beziershape ()
 
virtual Thunk * to_thunk ()
 
virtual Renderer * to_renderer ()
 
virtual Box2 & to_box2 ()
 
virtual NURBSTextureSurface * to_nurbstexturesurface ()
 
virtual NURBSDisplay * to_nurbsdisplay ()
 
virtual TessApprox * to_tessapprox ()
 
virtual Value * widen_to (Value *arg, Value **arg_list)
 
virtual BOOL comparable (Value *arg)
 
virtual BOOL special_case_compare (Value *arg, bool &specialCaseCompareResult)
 
virtual ScripterExport Value * deep_copy (HashTable *remapper)
 
virtual BOOL is_const ()
 
virtual ScripterExport Value * get_property (Value **arg_list, int count)
 
virtual ScripterExport Value * set_property (Value **arg_list, int count)
 
ScripterExport Value * _get_property (Value *prop)
 
virtual ScripterExport Value * _set_property (Value *prop, Value *val)
 
virtual Value * get_container_property (Value *prop, Value *cur_prop)
 
virtual Value * set_container_property (Value *prop, Value *val, Value *cur_prop)
 
virtual BOOL _is_collection ()
 
virtual BOOL _is_charstream ()
 
virtual BOOL _is_rolloutcontrol ()
 
virtual BOOL _is_rolloutthunk ()
 
virtual BOOL _is_function ()
 
virtual BOOL _is_selection ()
 
virtual BOOL _is_thunk ()
 
virtual BOOL _is_indirect_thunk ()
 
virtual SelectionIterator * selection_iterator ()
 
virtual void drop_MAX_refs ()
 
virtual BaseInterface * GetInterface (Interface_ID id)
 
ScripterExport Value * make_heap_permanent ()
 
ScripterExport Value * make_heap_static ()
 
ScripterExport Value * get_heap_ptr ()
 
ScripterExport Value * get_stack_heap_ptr ()
 
ScripterExport Value * migrate_to_heap ()
 
ScripterExport Value * get_live_ptr ()
 
virtual BOOL object_supports_case_sensitive_names ()
 
ScripterExport Value * _get_property (Value *prop, Value *prop_name_as_parsed)
 
ScripterExport Value * _set_property (Value *prop, Value *val, Value *prop_name_as_parsed)
 
virtual ScripterExport Value * get_case_sensitive_property (Value **arg_list, int count, const TCHAR *case_sensitive_name)
 
virtual ScripterExport Value * set_case_sensitive_property (Value **arg_list, int count, const TCHAR *case_sensitive_name)
 
ScripterExport Value * invoke_getter_case_sensitive_property (Value *target, getter_vf getter, Value **arg_list, int count, const TCHAR *case_sensitive_name, const TCHAR *nested_prop_case_sensitive_name)
 
ScripterExport Value * invoke_setter_case_sensitive_property (Value *target, setter_vf setter, Value **arg_list, int count, const TCHAR *case_sensitive_name, const TCHAR *nested_prop_case_sensitive_name)
 
- Public Member Functions inherited from Collectable
ScripterExport Collectable ()
 
virtual ScripterExport ~Collectable ()
 
ScripterExport void * operator new (size_t sz, char flag)
 
ScripterExport void * operator new (size_t sz)
 
ScripterExport void operator delete (void *val)
 
ScripterExport void operator delete (void *val, char flag)
 
virtual ScripterExport void gc_trace ()
 
ScripterExport bool derives_from_Animatable ()
 
virtual BOOL derives_from_MAXWrapper ()
 
ScripterExport void make_collectable ()
 
void make_permanent ()
 
void make_static ()
 
int is_marked ()
 
int is_not_marked ()
 
int is_garbage ()
 
int is_permanent ()
 
void mark_in_use ()
 
void unmark_in_use ()
 
int has_heap_copy ()
 
int is_in_heap ()
 
int is_on_stack ()
 

Static Public Member Functions

static ScripterExport Value * intern (AColor col)
 
static ScripterExport Value * intern (float r, float g, float b, float a=1.0f)
 
static ScripterExport Value * intern (BMM_Color_64 &col)
 
static Value * Load (ILoad *iload, USHORT chunkID, ValueLoader *vload)
 
- Static Public Member Functions inherited from Collectable
static ScripterExport void for_all_values (void(*map_fn)(Value *val), ValueMapper *mapper=NULL, ValueMetaClass *c=NULL)
 
static void mark ()
 
static void sweep ()
 
static void setup (size_t)
 
static ScripterExport void gc ()
 
static void coalesce_free_list ()
 
static void close_down ()
 
static void drop_maxwrapper_refs ()
 
static ScripterExport void push_alloc_stack_frame ()
 
static ScripterExport void pop_alloc_stack_frame ()
 
static ScripterExport ULONGLONG get_num_values_created ()
 
static ScripterExport bool validate_value_linkages ()
 

Public Attributes

AColor color
 
- Public Attributes inherited from Value
ValueMetaClass * tag
 
- Public Attributes inherited from Collectable
Collectable * next
 
Collectable * prev
 
byte flags
 
byte flags2
 
short flags3
 

Additional Inherited Members

- Static Public Attributes inherited from Collectable
static CRITICAL_SECTION heap_update
 
static Collectable * collectable_list
 
static Collectable * permanent_list
 
static free_mem * free_list [GC_NUM_SUBLISTS]
 
static size_t heap_allocated
 
static size_t heap_size
 
static ScripterExport collectable_state state
 
static ScripterExport bool fullCollectNextHoldFlush
 
static bool gc_light
 
static bool in_gc
 
static HANDLE hGCCompletedEvent
 
- Static Protected Attributes inherited from Value
static ScripterExport Value * keyarg_marker_value
 

Constructor & Destructor Documentation

◆ ColorValue() [1/7]

◆ ColorValue() [2/7]

◆ ColorValue() [3/7]

ScripterExport ColorValue ( COLORREF  col)

◆ ColorValue() [4/7]

◆ ColorValue() [5/7]

◆ ColorValue() [6/7]

◆ ColorValue() [7/7]

ScripterExport ColorValue ( float  r,
float  g,
float  b,
float  a = 1.0f 
)

◆ ~ColorValue()

Member Function Documentation

◆ ENABLE_STACK_ALLOCATE()

ENABLE_STACK_ALLOCATE ( ColorValue  )

◆ intern() [1/3]

static ScripterExport Value* intern ( AColor  col)
static

◆ intern() [2/3]

static ScripterExport Value* intern ( float  r,
float  g,
float  b,
float  a = 1.0f 
)
static

◆ intern() [3/3]

static ScripterExport Value* intern ( BMM_Color_64 &  col)
static

◆ classof_methods()

classof_methods ( ColorValue  ,
Value   
)

◆ collect()

void collect ( )
virtual

Implements Collectable.

Reimplemented in ConstColorValue.

◆ sprin1()

ScripterExport void sprin1 ( CharStream *  s)
virtual

Reimplemented from Value.

◆ def_generic() [1/2]

def_generic ( coerce  ,
"coerce"   
)

◆ def_generic() [2/2]

def_generic ( copy  ,
"copy"   
)

◆ def_property() [1/7]

def_property ( red  )

◆ def_local_prop_alias() [1/7]

def_local_prop_alias ( r  ,
red   
)

◆ def_property() [2/7]

def_property ( green  )

◆ def_local_prop_alias() [2/7]

def_local_prop_alias ( g  ,
green   
)

◆ def_property() [3/7]

def_property ( blue  )

◆ def_local_prop_alias() [3/7]

def_local_prop_alias ( b  ,
blue   
)

◆ def_property() [4/7]

def_property ( alpha  )

◆ def_local_prop_alias() [4/7]

def_local_prop_alias ( a  ,
alpha   
)

◆ def_property() [5/7]

def_property ( hue  )

◆ def_local_prop_alias() [5/7]

def_local_prop_alias ( h  ,
hue   
)

◆ def_property() [6/7]

def_property ( saturation  )

◆ def_local_prop_alias() [6/7]

def_local_prop_alias ( s  ,
saturation   
)

◆ def_property() [7/7]

def_property ( value  )

◆ def_local_prop_alias() [7/7]

def_local_prop_alias ( v  ,
value   
)

◆ to_acolor()

AColor to_acolor ( )
inlinevirtual

Reimplemented from Value.

67 { return color; }
AColor color
Definition: colors.h:22

◆ to_color()

Color to_color ( )
inline
68 { return Color (color.r, color.g, color.b); }
float r
These values are in the range 0.0 to 1.0.
Definition: acolor.h:36
float b
Definition: acolor.h:38
float g
Definition: acolor.h:37
Definition: color.h:73

◆ to_colorref()

COLORREF to_colorref ( )
inlinevirtual

Reimplemented from Value.

69 { return RGB((int)(color.r * 255.0f), (int)(color.g * 255.0f), (int)(color.b * 255.0f)); }

◆ to_point3()

Point3 to_point3 ( )
inlinevirtual

Reimplemented from Value.

70 { return Point3 (color.r * 255.0, color.g * 255.0, color.b * 255.0); }
Definition: point3.h:54

◆ to_point4()

Point4 to_point4 ( )
inlinevirtual

Reimplemented from Value.

71 { return Point4 (color.r, color.g, color.b, color.a); }
float a
Definition: acolor.h:39
Definition: point4.h:41

◆ to_fpvalue()

void to_fpvalue ( FPValue &  v)
virtual

Reimplemented from Value.

◆ Save()

IOResult Save ( ISave *  isave)
virtual

Reimplemented from Value.

◆ Load()

static Value* Load ( ILoad *  iload,
USHORT  chunkID,
ValueLoader *  vload 
)
static

Member Data Documentation

◆ color

AColor color