CheckboxWidget Class Reference

The CheckboxWidget JavaScript class. A checkbox widget. More...

Signals

void valueChanged (bool value)
 Signal notifying the user that the value was modified by the Transform Tool. More...
 
- Signals inherited from WidgetBase
void dragStarted (QScriptValue dragContext)
 signal called on mouse down when picking this widget with the Transform tool More...
 
void drag (QScriptValue dragContext)
 signal called when this widget is dragged with the Transform tool More...
 
void dragEnded ()
 signal called on mouse up after having manipulated this widget with the Transform tool More...
 

Public Member Functions

virtual void onDrag (MC_DragContext &dragContext) override
 

Additional Inherited Members

- Public Slots inherited from WidgetBase
Attributedata (int index=0)
 
void updateProperties (QScriptValue properties)
 

Detailed Description

The CheckboxWidget JavaScript class. A checkbox widget.

This widget must be linked to a BOOL attribute. The widget manipulator is a square area. The color for the on/off states can be specified at object creation. When the area is clicked, the BOOL attribute is set to true, a cross is displayed in the widget box, and the "on" color is shown.

The following properties are supported by the widget:

Property Type Default Value Description
data String - The name of the automatically generated position attribute (if none is provided)
data Attribute - An attribute of BOOL type that can be shared with another widget or node.
size float 1.00 The size (half-extent) of the box.
screen_space bool false When set to true, the checkbox position becomes relative to the screen rather than the scene.
position Point2d Point2d(0,0) Position of the box center in the scene, specified in fields.
outer_color ColorRGBA 0, 0, 0,255 The outer colour of the box.
on_color ColorRGBA 0,255, 0,128 The inner colour of the box, when checked.
off_color ColorRGBA 255, 0, 0,128 The outer colour of the box, when unchecked.
label String "text" Label text
label_color ColorRGBA 255,255,255,255 Label foreground (text) color.
label_bg_color ColorRGBA 0, 0, 0,128 Label background color. Accepts transparency values.
label_font String "Arial" Label font name.
label_size float 10.0 Label font size, in points.
label_pos Point2d Point2d(0,0) Label position, in fields.
label_justify String "Left" Horizontal label text alignment ("Left"/"Center").
label_screenspace bool true Forces the label size to remain constant relative to screen.
label_screenspace_offset Point2d Point2d(0,0) Label position offset, in screen space.

The following components constitute the widget:

Component Type
attribute BOOL
drag_manipulator BUTTON
painter CHECKBOX
picker MONO
local_transformation -

Create this widget to add a floating Master Controller in the camera view:

{
MessageLog.trace("\n\n\n");
MessageLog.trace(" ---------------------------------------------------------------------------");
MessageLog.trace("| Checkbox Widget Test");
MessageLog.trace(" ---------------------------------------------------------------------------");
var valAttr = node.getAttr(Controller.node, frame.current(), "checkbox_value");
var mcNameCapture = Controller.node;
var checkboxWidget = new CheckboxWidget(
{
data: valAttr,
position : Point2d(0.,0.),
screen_space : false,
outer_color : ColorRGBA(0,0,0,255),
on_color : ColorRGBA(0,255,0,128),
off_color : ColorRGBA(255,0,0,128),
size : 1,
label : "myText",
label_color : ColorRGBA(0,0,0,255),
label_bg_color : ColorRGBA(0,0,0,128),
label_font : "Arial",
label_size : 18,
label_pos : Point2d(0,0),
label_screenspace_offset : Point2d(0,-400),
label_justify : "Center",
label_screenspace : false
} );
checkboxWidget.valueChanged.connect(function(toggleValue)
{
MessageLog.trace("checkboxWidget.valueChanged!");
});
Controller.controls = [checkboxWidget];
MessageLog.trace("Done.");
}

Make sure to setup the Master Controller node specifications properly. e.g.

<attributes>
<attr type="BOOL" name="checkbox_value" value="false" tooltip="Checkbox ON/OFF value."/>
</attributes>

Member Function Documentation

◆ onDrag()

virtual void CheckboxWidget::onDrag ( MC_DragContext &  dragContext)
overridevirtual

Reimplemented from WidgetBase.

◆ valueChanged

void CheckboxWidget::valueChanged ( bool  value)
signal

Signal notifying the user that the value was modified by the Transform Tool.

Parameters
valuethe toggle value. value is of JavaScript type bool