EnvSceneSelector.EnvSceneSelector Class Reference
#include
<class_env_scene_selector_1_1_env_scene_selector.h>
Public Member Functions |
|
| __init__ () | |
| cleanup () | |
| setSize () | |
| 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. |
|
| setEnvironments () | |
| Call to update the UI showing environments in the scene.
|
|
| setLoadingEnvironment () | |
| Call when loading of an environment begins
and ends. |
|
| selectSceneEnvironmentCallback () | |
| This method is called whenever an
environment in the scene list is clicked on. |
|
| renameSceneEnvironmentCallback () | |
| This method is called whenever an
environment in the scene list is double-clicked on. |
|
| Frame () | |
| Called on each frame update. |
|
Member Function Documentation
| EnvSceneSelector.EnvSceneSelector.__init__ | ( | ) |
| EnvSceneSelector.EnvSceneSelector.cleanup | ( | ) |
| EnvSceneSelector.EnvSceneSelector.setSize | ( | ) |
| EnvSceneSelector.EnvSceneSelector.setVisible | ( | ) |
| EnvSceneSelector.EnvSceneSelector.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.
| EnvSceneSelector.EnvSceneSelector.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.
| EnvSceneSelector.EnvSceneSelector.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.
| EnvSceneSelector.EnvSceneSelector.release | ( | ) |
| EnvSceneSelector.EnvSceneSelector.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.
| EnvSceneSelector.EnvSceneSelector.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.
| EnvSceneSelector.EnvSceneSelector.setEnvironments | ( | ) |
Call to update the UI showing environments in the scene.
Needs to be called whenever:
- An environment is copied from the library in to the scene.
- The current environment changes.
- The application mode (Viewing vs. Authoring) changes.
| EnvSceneSelector.EnvSceneSelector.setLoadingEnvironment | ( | ) |
Call when loading of an environment begins and ends.
| EnvSceneSelector.EnvSceneSelector.selectSceneEnvironmentCallback | ( | ) |
This method is called whenever an environment in the scene list is clicked on.
| EnvSceneSelector.EnvSceneSelector.renameSceneEnvironmentCallback | ( | ) |
This method is called whenever an environment in the scene list is double-clicked on.
| EnvSceneSelector.EnvSceneSelector.Frame | ( | ) |
Called on each frame update.
Animate the lists, if they are being scrolled.
