EnvLibrarySelector.EnvLibrarySelector Class Reference
#include
<class_env_library_selector_1_1_env_library_selector.h>
Public Member Functions |
|
| __init__ () | |
| cleanup () | |
| setSize () | |
| Returns True if the sizing was actually
modified. |
|
| setVisible () | |
| popupMenu () | |
| If the UI wants to show a popup menu then this is
the time to do it. |
|
| highlight () | |
| Call when you want to highlight a control at
the specified position. |
|
| select () | |
| Call when you want to select a control at
the specified position. |
|
| release () | |
| Called on mouse up event, pass on to lists.
|
|
| scrollUp () | |
| Call when you want to scroll the UI in response to some event,
typically the mouse wheel. |
|
| scrollDown () | |
| Call when you want to scroll the UI in response to some event,
typically the mouse wheel. |
|
| setLibraryEnvironments () | |
| Call to popuplate the UI with the contents of the Environment
Library. |
|
| setSceneEnvironments () | |
| updateAuthoringMode () | |
| renameEnvironmentCallback () | |
| This method is called whenever an
environment in the library list is double-clicked on. |
|
| selectLibraryEnvironmentCallback () | |
| This method is called whenever you click on
an environment in the library, or on a library heading. |
|
| Frame () | |
| Called on each frame update. |
|
Member Function Documentation
| EnvLibrarySelector.EnvLibrarySelector.__init__ | ( | ) |
Reimplemented from UiSceneSelector.UiSceneSelector.
| EnvLibrarySelector.EnvLibrarySelector.cleanup | ( | ) |
Reimplemented from UiSelector.UiSelector.
| EnvLibrarySelector.EnvLibrarySelector.setSize | ( | ) |
Returns True if the sizing was actually modified.
Reimplemented from UiSelector.UiSelector.
| EnvLibrarySelector.EnvLibrarySelector.setVisible | ( | ) |
Reimplemented from UiSelector.UiSelector.
| EnvLibrarySelector.EnvLibrarySelector.popupMenu | ( | ) |
If the UI wants to show a popup menu then this is the time to do it.
The popup menu may vary depending on what part of the UI the mouse pointer is over. Use the position argument to determine what UI is under the pointer.
Return True if the position argument is over a part of the UI. You should return True whether you show a popup menu or not.
| EnvLibrarySelector.EnvLibrarySelector.highlight | ( | ) |
Call when you want to highlight a control at the specified position.
Test each control in the UI to see if it contains the given position.
Return the control containing the position, or None if no control does.
| EnvLibrarySelector.EnvLibrarySelector.select | ( | ) |
Call when you want to select a control at the specified position.
Test each control in the UI to see if it contains the given position.
Return the control containing the position, or None if no control does.
| EnvLibrarySelector.EnvLibrarySelector.release | ( | ) |
| EnvLibrarySelector.EnvLibrarySelector.scrollUp | ( | ) |
Call when you want to scroll the UI in response to some event, typically the mouse wheel.
Scrolling happens only if the mouse pointer is over the UI.
Return True to indicate the mouse pointer is over the UI and scrolling was attempted. Note that actual scrolling may not have happened because the UI is already fully scrolled up.
| EnvLibrarySelector.EnvLibrarySelector.scrollDown | ( | ) |
Call when you want to scroll the UI in response to some event, typically the mouse wheel.
Scrolling happens only if the mouse pointer is over the UI.
Return True to indicate the mouse pointer is over the UI and scrolling was attempted. Note that actual scrolling may not have happened because the UI is already fully scrolled down.
| EnvLibrarySelector.EnvLibrarySelector.setLibraryEnvironments | ( | ) |
Call to popuplate the UI with the contents of the Environment Library.
Find all the libraries and the environments in each library, grouping the accordingly. For example:
Library 2 Environment1 Environment2
Library 1 Environment1 Environment2 Environment3
Library 3 Environment1
Also construct an environment image map. This needs to be passed to each of the list controls.
| EnvLibrarySelector.EnvLibrarySelector.setSceneEnvironments | ( | ) |
| EnvLibrarySelector.EnvLibrarySelector.updateAuthoringMode | ( | ) |
| EnvLibrarySelector.EnvLibrarySelector.renameEnvironmentCallback | ( | ) |
This method is called whenever an environment in the library list is double-clicked on.
| EnvLibrarySelector.EnvLibrarySelector.selectLibraryEnvironmentCallback | ( | ) |
This method is called whenever you click on an environment in the library, or on a library heading.
| EnvLibrarySelector.EnvLibrarySelector.Frame | ( | ) |
Called on each frame update.
Animate the lists, if they are being scrolled.
Reimplemented from UiSelector.UiSelector.
