UiSceneSelector.UiSceneSelector Class Reference


Detailed Description

This class serves as a common class for selectors that need to know about the scene.

Currently its main responsibility is to manage the storyboard-specific menu item.

It must be used in conjunction with the UiSceneSelector class.

#include <class_ui_scene_selector_1_1_ui_scene_selector.h>

Inheritance diagram for UiSceneSelector.UiSceneSelector:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ ()
  setType ()
  Sets the type of storyboard slide that will be created by this selector.
  getType ()
  Returns the type of storyboard slide that this selector would create in addToSlide().
  setDocument ()
  getDocument ()
  updateStoryboardSelector ()
  addToTrigger ()
  Adds the given selector item to a storyboard.
  removeFromTriggers ()
  Remove a given ui element from all triggers that it is associated with.
  addToSlide ()
  Adds the given selector item to a storyboard.
  addPopupMenuItems ()
  Append a menu item to add the current thing to the storyboard slide or to add to a new storyboard slide.
  isStoryboardEmpty ()
  isItemInSlide ()

Member Function Documentation

UiSceneSelector.UiSceneSelector.__init__ ( )
UiSceneSelector.UiSceneSelector.setType ( )

Sets the type of storyboard slide that will be created by this selector.

See SlideItem class. The type must be set before adding any calls to addToSlide().

UiSceneSelector.UiSceneSelector.getType ( )

Returns the type of storyboard slide that this selector would create in addToSlide().

UiSceneSelector.UiSceneSelector.setDocument ( )
UiSceneSelector.UiSceneSelector.getDocument ( )
UiSceneSelector.UiSceneSelector.updateStoryboardSelector ( )
UiSceneSelector.UiSceneSelector.addToTrigger ( )

Adds the given selector item to a storyboard.

If there are no storyboard slides, then create a slide before adding to it.

UiSceneSelector.UiSceneSelector.removeFromTriggers ( )

Remove a given ui element from all triggers that it is associated with.

UiSceneSelector.UiSceneSelector.addToSlide ( )

Adds the given selector item to a storyboard.

If there are no storyboard slides, then create a slide before adding to it.

UiSceneSelector.UiSceneSelector.addPopupMenuItems ( )

Append a menu item to add the current thing to the storyboard slide or to add to a new storyboard slide.

The menu item is only available when:

  • in professional mode
  • in authoring
UiSceneSelector.UiSceneSelector.isStoryboardEmpty ( )
UiSceneSelector.UiSceneSelector.isItemInSlide ( )

UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector
UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector UiSceneSelector.UiSceneSelector