3ds Max C++ API Reference
RolloutControl Class Referenceabstract

#include <rollouts.h>

+ Inheritance diagram for RolloutControl:

Public Member Functions

ScripterExport RolloutControl (Value *name, Value *caption, Value **keyparms, int keyparm_count)
 
ScripterExport ~RolloutControl ()
 
 classof_methods (RolloutControl, Value)
 
BOOL _is_rolloutcontrol () override
 
void collect () override
 
virtual ScripterExport void gc_trace () override
 
virtual ScripterExport Valueget_property (Value **arg_list, int count) override
 
virtual ScripterExport Valueset_property (Value **arg_list, int count) override
 
virtual ScripterExport void add_control (Rollout *ro, HWND parent, HINSTANCE hInst, int &current_y)
 
virtual ScripterExport void adjust_control (int &current_y)
 
virtual LPCMSTR get_control_class ()=0
 
virtual DWORD get_control_style ()
 
virtual DWORD get_control_ex_style ()
 
virtual void init_control (HWND control)
 
virtual void compute_layout (Rollout *ro, layout_data *pos)
 
virtual ScripterExport void compute_layout (Rollout *ro, layout_data *pos, int &current_y)
 
virtual ScripterExport void process_layout_params (Rollout *ro, layout_data *pos, int &current_y)
 
virtual ScripterExport void setup_layout (Rollout *ro, layout_data *pos, int &current_y)
 
virtual ScripterExport void process_common_params ()
 
virtual ScripterExport void call_event_handler (Rollout *ro, Value *event, Value **arg_list, int count)
 
virtual ScripterExport void run_event_handler (Rollout *ro, Value *event, Value **arg_list, int count)
 
virtual BOOL handle_message (Rollout *ro, UINT message, WPARAM wParam, LPARAM lParam)
 
ScripterExport WORD next_id ()
 
virtual ScripterExport void set_text (const MCHAR *text, HWND ctl=NULL, Value *align=NULL)
 
virtual ScripterExport void set_enable ()
 
virtual ScripterExport BOOL set_focus ()
 
virtual int num_controls ()
 
ScripterExport Valueget_event_handler (Value *event)
 
ScripterExport Valueget_wrapped_event_handler (Value *event)
 
virtual void ui_time_changed ()
 
virtual Controlget_controller ()
 
virtual BOOL controller_ok (Control *c)
 
ScripterExport HWND GetHWND ()
 
ScripterExport bool IsDisabledExternally ()
 
ScripterExport IParamBlock2get_pblock ()
 
virtual void Reload ()
 
virtual void InvalidateUI ()
 
virtual void set_pb2_value ()
 
virtual void get_pb2_value (BOOL load_UI=TRUE)
 
virtual void SetTexDADMgr (DADMgr *dad)
 
virtual int FindSubTexFromHWND (HWND hw)
 
virtual void SetMtlDADMgr (DADMgr *dad)
 
virtual int FindSubMtlFromHWND (HWND hw)
 
- Public Member Functions inherited from Value
virtual ScripterExport BOOL is_kind_of (ValueMetaClass *c)
 
virtual ScripterExport ValueMetaClasslocal_base_class ()
 
virtual Valueeval ()
 
virtual Valueeval_no_wrapper ()
 
virtual ScripterExport Valueapply (Value **arglist, int count, CallContext *cc=NULL)
 
virtual ScripterExport Valueapply_no_alloc_frame (Value **arglist, int count, CallContext *cc=NULL)
 
virtual void export_to_scripter ()
 
virtual Valuemap (node_map &m)
 
virtual Valuemap_path (PathName *path, node_map &m)
 
virtual Valuefind_first (BOOL(*test_fn)(INode *node, int level, const void *arg), const void *test_arg)
 
virtual Valueget_path (PathName *path)
 
virtual ScripterExport void sprin1 (CharStream *stream)
 
virtual ScripterExport void sprint (CharStream *stream)
 
virtual void prin1 ()
 
virtual void print ()
 
virtual ScripterExport Class_ID get_max_class_id ()
 
virtual ScripterExport Valuedelete_vf (Value **arglist, int arg_count)
 
virtual ScripterExport ValueclearSelection_vf (Value **arglist, int arg_count)
 
virtual float to_float ()
 
virtual double to_double ()
 
virtual const MCHARto_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 BitArrayto_bitarray ()
 
virtual Point4 to_point4 ()
 
virtual Point3 to_point3 ()
 
virtual Point2 to_point2 ()
 
virtual AColor to_acolor ()
 
virtual COLORREF to_colorref ()
 
virtual INodeto_node ()
 
virtual Ray to_ray ()
 
virtual Interval to_interval ()
 
virtual Quat to_quat ()
 
virtual AngAxis to_angaxis ()
 
virtual Matrix3to_matrix3 ()
 
virtual Box3 to_box3 ()
 
virtual float * to_eulerangles ()
 
virtual Mtlto_mtl ()
 
virtual Texmapto_texmap ()
 
virtual MtlBaseto_mtlbase ()
 
virtual Modifierto_modifier ()
 
virtual TimeValue to_timevalue ()
 
virtual Controlto_controller ()
 
virtual Atmosphericto_atmospheric ()
 
virtual Effectto_effect ()
 
virtual IMultiPassCameraEffectto_mpassCamEffect ()
 
virtual ShadowTypeto_shadowtype ()
 
virtual FilterKernelto_filter ()
 
virtual INodeto_rootnode ()
 
virtual ITrackViewNodeto_trackviewnode ()
 
virtual NURBSIndependentPointto_nurbsindependentpoint ()
 
virtual NURBSPointto_nurbspoint ()
 
virtual NURBSObjectto_nurbsobject ()
 
virtual NURBSControlVertexto_nurbscontrolvertex ()
 
virtual NURBSCurveto_nurbscurve ()
 
virtual NURBSCVCurveto_nurbscvcurve ()
 
virtual NURBSSurfaceto_nurbssurface ()
 
virtual NURBSTexturePointto_nurbstexturepoint ()
 
virtual NURBSSetto_nurbsset ()
 
virtual ReferenceTargetto_reftarg ()
 
virtual Meshto_mesh ()
 
virtual BezierShapeto_beziershape ()
 
virtual Thunkto_thunk ()
 
virtual void to_fpvalue (FPValue &v)
 
virtual Rendererto_renderer ()
 
virtual Box2to_box2 ()
 
virtual NURBSTextureSurfaceto_nurbstexturesurface ()
 
virtual NURBSDisplayto_nurbsdisplay ()
 
virtual TessApproxto_tessapprox ()
 
virtual Valuewiden_to (Value *arg, Value **arg_list)
 
virtual BOOL comparable (Value *arg)
 
virtual BOOL special_case_compare (Value *arg, bool &specialCaseCompareResult)
 
virtual ScripterExport Valuedeep_copy (HashTable *remapper)
 
virtual BOOL is_const ()
 
ScripterExport Value_get_property (Value *prop)
 
virtual ScripterExport Value_set_property (Value *prop, Value *val)
 
virtual Valueget_container_property (Value *prop, Value *cur_prop)
 
virtual Valueset_container_property (Value *prop, Value *val, Value *cur_prop)
 
virtual BOOL _is_collection ()
 
virtual BOOL _is_charstream ()
 
virtual BOOL _is_rolloutthunk ()
 
virtual BOOL _is_function ()
 
virtual BOOL _is_selection ()
 
virtual BOOL _is_thunk ()
 
virtual BOOL _is_indirect_thunk ()
 
virtual SelectionIteratorselection_iterator ()
 
virtual ScripterExport IOResult Save (ISave *isave)
 
virtual void drop_MAX_refs ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
ScripterExport Valuemake_heap_permanent ()
 
ScripterExport Valuemake_heap_static ()
 
ScripterExport Valueget_heap_ptr ()
 
ScripterExport Valueget_stack_heap_ptr ()
 
ScripterExport Valuemigrate_to_heap ()
 
ScripterExport Valueget_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 Valueget_case_sensitive_property (Value **arg_list, int count, const TCHAR *case_sensitive_name)
 
virtual ScripterExport Valueset_case_sensitive_property (Value **arg_list, int count, const TCHAR *case_sensitive_name)
 
ScripterExport Valueinvoke_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 Valueinvoke_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 voidoperator new (size_t sz, char flag)
 
ScripterExport voidoperator 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 ()
 

Public Attributes

Valuename
 
Valuecaption
 
Valueinit_caption
 
BOOL enabled
 
Value ** keyparms
 
int keyparm_count
 
Rolloutparent_rollout
 
WORD control_ID
 
PB2Parampid
 
short flags
 
- Public Attributes inherited from Value
ValueMetaClasstag
 
- Public Attributes inherited from Collectable
Collectablenext
 
Collectableprev
 
byte flags
 
byte flags2
 
short flags3
 

Additional Inherited Members

- 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 ()
 
- Static Public Attributes inherited from Collectable
static CRITICAL_SECTION heap_update
 
static Collectablecollectable_list
 
static Collectablepermanent_list
 
static free_memfree_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 Valuekeyarg_marker_value
 

Constructor & Destructor Documentation

◆ RolloutControl()

ScripterExport RolloutControl ( Value name,
Value caption,
Value **  keyparms,
int  keyparm_count 
)

◆ ~RolloutControl()

Member Function Documentation

◆ classof_methods()

classof_methods ( RolloutControl  ,
Value   
)

◆ _is_rolloutcontrol()

BOOL _is_rolloutcontrol ( )
inlineoverridevirtual

Reimplemented from Value.

268 { return 1; }

◆ collect()

◆ gc_trace()

◆ get_property()

◆ set_property()

◆ add_control()

virtual ScripterExport void add_control ( Rollout ro,
HWND  parent,
HINSTANCE  hInst,
int current_y 
)
virtual

◆ adjust_control()

◆ get_control_class()

◆ get_control_style()

virtual DWORD get_control_style ( )
inlinevirtual

Reimplemented in BitmapControl, CheckBoxControl, RadioControl, ListBoxControl, ComboBoxControl, and LabelControl.

283 { return WS_TABSTOP; }

◆ get_control_ex_style()

virtual DWORD get_control_ex_style ( )
inlinevirtual

Reimplemented in BitmapControl.

284 { return 0; }

◆ init_control()

virtual void init_control ( HWND  control)
inlinevirtual

◆ compute_layout() [1/2]

virtual void compute_layout ( Rollout ro,
layout_data pos 
)
inlinevirtual

◆ compute_layout() [2/2]

virtual ScripterExport void compute_layout ( Rollout ro,
layout_data pos,
int current_y 
)
virtual

◆ process_layout_params()

virtual ScripterExport void process_layout_params ( Rollout ro,
layout_data pos,
int current_y 
)
virtual

Reimplemented in BitmapControl.

◆ setup_layout()

virtual ScripterExport void setup_layout ( Rollout ro,
layout_data pos,
int current_y 
)
virtual

◆ process_common_params()

virtual ScripterExport void process_common_params ( )
virtual

Reimplemented in AnimatableRolloutControl.

◆ call_event_handler()

virtual ScripterExport void call_event_handler ( Rollout ro,
Value event,
Value **  arg_list,
int  count 
)
virtual

◆ run_event_handler()

virtual ScripterExport void run_event_handler ( Rollout ro,
Value event,
Value **  arg_list,
int  count 
)
virtual

◆ handle_message()

virtual BOOL handle_message ( Rollout ro,
UINT  message,
WPARAM  wParam,
LPARAM  lParam 
)
inlinevirtual

◆ next_id()

ScripterExport WORD next_id ( )

◆ set_text()

virtual ScripterExport void set_text ( const MCHAR text,
HWND  ctl = NULL,
Value align = NULL 
)
virtual

◆ set_enable()

◆ set_focus()

virtual ScripterExport BOOL set_focus ( )
virtual

Reimplemented in RadioControl, and SpinnerControl.

◆ num_controls()

virtual int num_controls ( )
inlinevirtual

◆ get_event_handler()

ScripterExport Value* get_event_handler ( Value event)

◆ get_wrapped_event_handler()

ScripterExport Value* get_wrapped_event_handler ( Value event)

◆ ui_time_changed()

virtual void ui_time_changed ( )
inlinevirtual

Reimplemented in AnimatableRolloutControl.

305 { } // called when the ui time has changed, implement if control needs to be updated

◆ get_controller()

virtual Control* get_controller ( )
inlinevirtual

Reimplemented in AnimatableRolloutControl.

306 { return nullptr; } // get the controller for this rollout control. Overrriden by AnimatableRolloutControl

◆ controller_ok()

virtual BOOL controller_ok ( Control c)
inlinevirtual

Reimplemented in AnimatableRolloutControl, SliderControl, and SpinnerControl.

307 { return FALSE; } // return TRUE if controller 'c' can be assigned to the ui control

◆ GetHWND()

ScripterExport HWND GetHWND ( )

◆ IsDisabledExternally()

ScripterExport bool IsDisabledExternally ( )

◆ get_pblock()

ScripterExport IParamBlock2* get_pblock ( )

◆ Reload()

◆ InvalidateUI()

◆ set_pb2_value()

◆ get_pb2_value()

◆ SetTexDADMgr()

virtual void SetTexDADMgr ( DADMgr dad)
inlinevirtual

Reimplemented in MapButtonControl.

322 { }

◆ FindSubTexFromHWND()

virtual int FindSubTexFromHWND ( HWND  hw)
inlinevirtual

Reimplemented in MapButtonControl.

323 { return -1; }

◆ SetMtlDADMgr()

virtual void SetMtlDADMgr ( DADMgr dad)
inlinevirtual

Reimplemented in MtlButtonControl.

324 { }

◆ FindSubMtlFromHWND()

virtual int FindSubMtlFromHWND ( HWND  hw)
inlinevirtual

Reimplemented in MtlButtonControl.

325 { return -1; }

Member Data Documentation

◆ name

Value* name

◆ caption

Value* caption

◆ init_caption

Value* init_caption

◆ enabled

BOOL enabled

◆ keyparms

Value** keyparms

◆ keyparm_count

int keyparm_count

◆ parent_rollout

Rollout* parent_rollout

◆ control_ID

WORD control_ID

◆ pid

PB2Param* pid

◆ flags

short flags