Listener Class Reference

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/maxscript/util/listener.h>

Inheritance diagram for Listener:

Public Member Functions
	Listener (HINSTANCE mxs_instance, HWND MAX_window)
	Constructor. This is statically allocated.
	~Listener ()
	Destructor.
void	stop ()
	For shutting down the Listener thread, i.e. "run" method.
void	create_listener_window (HINSTANCE hInstance, HWND hwnd)
void	gc_trace () override
void	collect () override
ScripterExport void	set_keyinput_mode (int mode)
ScripterExport int	set_style (int style)
ScripterExport int	get_style ()
ScripterExport void	set_font (const MCHAR *font_name)
ScripterExport void	set_font_size (int fontSize)
ScripterExport bool	set_block_mini_updates (bool blocked)
ScripterExport bool	get_block_mini_updates ()
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=nullptr)
virtual ScripterExport Value *	apply_no_alloc_frame (Value **arglist, int count, CallContext *cc=nullptr)
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	sprin1 (CharStream *stream)
virtual ScripterExport void	sprint (CharStream *stream)
virtual void	prin1 ()
virtual void	print ()
virtual Class_ID	get_max_class_id ()
virtual Value *	delete_vf (Value **arglist, int arg_count)
virtual 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 ScripterExport bool	ValuesEqual (Value *other, bool strictCompare)
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 ScripterExport IOResult	Save (ISave *isave)
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 DWORD	run (Listener *l)
	The method that gets run for the Listener thread.
Static Public Member Functions inherited from Collectable
static ScripterExport void	for_all_values (void(*map_fn)(Value *val), ValueMapper *mapper=nullptr, ValueMetaClass *c=nullptr)
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
HWND	listener_window
HWND	edit_box
HWND	macrorec_box
HWND	mini_listener
HWND	mini_edit
HWND	mini_macrorec
WindowStream *	edit_stream
WindowStream *	macrorec_stream
WindowStream *	mini_edit_stream
WindowStream *	mini_macrorec_stream
Pipe *	source_pipe
int	flags
ListenerViewWindow *	lvw
msg_output_callback	msg_output_cb_precall
msg_output_callback	msg_output_cb_postcall
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

Listener()

Listener	(	HINSTANCE	mxs_instance,
		HWND	MAX_window )

Constructor. This is statically allocated.

When this constructor gets called, it starts a new thread using the run method.

~Listener()

~Listener

(

)

Destructor.

Since the Listener is statically allocated, this destructor gets called long after Max has uninitialized itself, and deleted all Collectable objects.

Member Function Documentation

run()

DWORD run ( Listener * l )

static

The method that gets run for the Listener thread.

stop()

void stop

(

)

For shutting down the Listener thread, i.e. "run" method.

This blocks until the Listener thread, i.e. Listener::run returns. In other words, it signals for the run thread to exit, then waits for the mShutdown_Event handle to get signaled.

create_listener_window()

void create_listener_window	(	HINSTANCE	hInstance,
		HWND	hwnd )

gc_trace()

void gc_trace ( )

overridevirtual

Reimplemented from Collectable.

collect()

void collect ( )

overridevirtual

Implements Collectable.

set_keyinput_mode()

ScripterExport void set_keyinput_mode ( int mode )

inline

{ flags = (flags & ~LSNR_INPUT_MODE_MASK) | mode; }

set_style()

ScripterExport int set_style

(

int

style

)

get_style()

ScripterExport int get_style

(

)

set_font()

ScripterExport void set_font

(

const MCHAR *

font_name

)

set_font_size()

ScripterExport void set_font_size

(

int

fontSize

)

set_block_mini_updates()

ScripterExport bool set_block_mini_updates

(

bool

blocked

)

get_block_mini_updates()

ScripterExport bool get_block_mini_updates

(

)

Member Data Documentation

listener_window

HWND listener_window

edit_box

HWND edit_box

macrorec_box

HWND macrorec_box

mini_listener

HWND mini_listener

mini_edit

HWND mini_edit

mini_macrorec

HWND mini_macrorec

edit_stream

WindowStream* edit_stream

macrorec_stream

WindowStream* macrorec_stream

mini_edit_stream

WindowStream* mini_edit_stream

mini_macrorec_stream

WindowStream* mini_macrorec_stream

source_pipe

Pipe* source_pipe

flags

int flags

lvw

ListenerViewWindow* lvw

msg_output_cb_precall

msg_output_callback msg_output_cb_precall

msg_output_cb_postcall

msg_output_callback msg_output_cb_postcall