MXSDictionaryValue Class Reference

#include <MXSDictionaryValue.h>

Inheritance diagram for MXSDictionaryValue:

Public Types
enum	key_type { key_name , key_string , key_int }

Public Member Functions
ScripterExport	MXSDictionaryValue (key_type keyType=key_name)
ScripterExport	~MXSDictionaryValue ()
	classof_methods (MXSDictionaryValue, Value)
BOOL	_is_collection ()
void	collect ()
void	gc_trace ()
void	sprin1 (CharStream *s)
Value *	deep_copy (HashTable *remapper) override
IOResult	Save (ISave *isave)
ScripterExport void	put (Value *key, Value *val, bool putOnlyIfNew=false)
ScripterExport void	set (Value *key, Value *val)
ScripterExport Value *	get (Value *key)
ScripterExport void	remove (Value *key)
ScripterExport bool	has (Value *key)
ScripterExport Array *	getKeys ()
ScripterExport void	free ()
ScripterExport key_type	getType ()
ScripterExport int	getCount ()
ScripterExport const HashTable *	getHashTable ()
ScripterExport bool	keyValueProperType (Value *key)
	def_property (count)
	def_property (type)
	def_property (keys)
void	type_check_key (Value *key, const MCHAR *where)
	use_generic (copy, "copy")
	use_generic (coerce, "coerce")
	use_generic (free, "free")
ScripterExport Value *	map (node_map &m)
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_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 Point4	to_point4 ()
virtual Point3	to_point3 ()
virtual Point2	to_point2 ()
virtual AColor	to_acolor ()
virtual COLORREF	to_colorref ()
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 void	to_fpvalue (FPValue &v)
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 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_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)
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 Value *	make (Value **arg_list, int count)
static Value *	Load (ILoad *iload, USHORT chunkID, ValueLoader *vload)
static DWORD_PTR	string_hash_fn (const void *key)
static int	dict_eq_fn_string (const void *key1, const void *key2)
static DWORD_PTR	int_hash_fn (const void *key)
static int	dict_eq_fn_int (const void *key1, const void *key2)
static ScripterExport bool	keyValueProperType (Value *key, key_type keyType)
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 ()

Protected Attributes
HashTable *	mHashTable = nullptr
key_type	mKeyType = key_name

Additional Inherited Members
Public Attributes inherited from Value
ValueMetaClass *	tag
Public Attributes inherited from Collectable
Collectable *	next
Collectable *	prev
byte	flags
byte	flags2
short	flags3
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

Member Enumeration Documentation

key_type

enum key_type

Enumerator
key_name
key_string
key_int

{ key_name, key_string, key_int};

Constructor & Destructor Documentation

MXSDictionaryValue()

ScripterExport MXSDictionaryValue

(

key_type

keyType = key_name

)

~MXSDictionaryValue()

ScripterExport ~MXSDictionaryValue ( )

inline

{}

Member Function Documentation

classof_methods()

classof_methods	(	MXSDictionaryValue	,
		Value
	)

_is_collection()

BOOL _is_collection ( )

inlinevirtual

Reimplemented from Value.

{ DbgAssert(!is_sourcepositionwrapper(this)); return 1; }

make()

static Value* make ( Value **  arg_list, int  count  )

static

collect()

void collect ( )

inlinevirtual

Implements Collectable.

{ delete this; }

gc_trace()

void gc_trace ( )

virtual

Reimplemented from Collectable.

sprin1()

void sprin1 ( CharStream *  s )

virtual

Reimplemented from Value.

deep_copy()

Value* deep_copy ( HashTable *  remapper )

overridevirtual

Reimplemented from Value.

Save()

IOResult Save ( ISave *  isave )

virtual

Reimplemented from Value.

Load()

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

static

string_hash_fn()

static DWORD_PTR string_hash_fn ( const void *  key )

static

dict_eq_fn_string()

static int dict_eq_fn_string ( const void *  key1, const void *  key2  )

static

int_hash_fn()

static DWORD_PTR int_hash_fn ( const void *  key )

static

dict_eq_fn_int()

static int dict_eq_fn_int ( const void *  key1, const void *  key2  )

static

put()

ScripterExport void put	(	Value *	key,
		Value *	val,
		bool	putOnlyIfNew = false
	)

set()

ScripterExport void set	(	Value *	key,
		Value *	val
	)

get()

ScripterExport Value* get

(

Value *

key

)

remove()

ScripterExport void remove

(

Value *

key

)

has()

ScripterExport bool has

(

Value *

key

)

getKeys()

ScripterExport Array* getKeys

(

)

free()

ScripterExport void free

(

)

getType()

ScripterExport key_type getType ( )

inline

{ return mKeyType; }

getCount()

ScripterExport int getCount

(

)

getHashTable()

ScripterExport const HashTable* getHashTable

(

)

keyValueProperType() [1/2]

ScripterExport bool keyValueProperType

(

Value *

key

)

keyValueProperType() [2/2]

static ScripterExport bool keyValueProperType ( Value *  key, key_type  keyType  )

static

def_property() [1/3]

def_property

(

count

)

def_property() [2/3]

def_property

(

type

)

def_property() [3/3]

def_property

(

keys

)

type_check_key()

void type_check_key	(	Value *	key,
		const MCHAR *	where
	)

use_generic() [1/3]

use_generic	(	copy	,
		"copy"
	)

use_generic() [2/3]

use_generic	(	coerce	,
		"coerce"
	)

use_generic() [3/3]

use_generic	(	free	,
		"free"
	)

map()

ScripterExport Value* map ( node_map &  m )

virtual

Reimplemented from Value.

Member Data Documentation

mHashTable

HashTable* mHashTable = nullptr

protected

mKeyType

key_type mKeyType = key_name

protected