SpotlightSelector.SpotlightSelector Class Reference
#include
<class_spotlight_selector_1_1_spotlight_selector.h>
Public Member Functions |
|
| __init__ () | |
| setSize () | |
| Returns True if the sizing was actually
modified. |
|
| getSize () | |
| setRegion () | |
| getRegion () | |
| popupMenu () | |
| There is no popup menu in this UI. |
|
| highlight () | |
| There is no highlighting in this overlay.
|
|
| select () | |
| There is no selection in this overlay.
|
|
| release () | |
| Called on a mouse up event. |
|
| scrollUp () | |
| There is no scrolling in this UI. |
|
| scrollDown () | |
| There is no scrolling in this UI. |
|
| ConvertScreenToLogical () | |
| Convert screen space coordinates to logical
coordinate range vertical range 0.0 to 1.0, horizontal based off
vertical with 0.0 being the center of the screen. |
|
| ConvertLogicalToScreen () | |
| Convert logical space coordinates to screen
space coordinates Logical puts 0,0 in the middle of the bottom
edge, with the height equalling 1. |
|
| SetLock () | |
| Locking the spotlight disallows changes to
the spotlight such as position and size. |
|
| isLocked () | |
| SetSpotCenter () | |
| Sets the center position of the spotlight,
as a logical range of the screen. |
|
| GetSpotCenter () | |
| Gets the center position of the spotlight,
as a logical range of the screen. |
|
| SetSpotScaleFactor () | |
| Sets how much to scale the spotlight from
the default image size. |
|
| IncreaseSpotScaleFactor () | |
| Expand the size of the spotlight. |
|
| DecreaseSpotScaleFactor () | |
| Contract the size of the spotlight. |
|
| getSpotlightDimensionsInScreenSpace () | |
| Returns the spotlight diameter and radius in
screen coordinates. |
|
| getSpotlightCenterInScreenSpace () | |
| Returns the spotlight center in screen
coordinates. |
|
| MousePositionChanged () | |
| Updates the spotlight location based on the
mouse position. |
|
| SendStateMessages () | |
| PositionLetterbox () | |
| Letterbox the spotlight area and then fill
the center with the spotlight image. |
|
Member Function Documentation
| SpotlightSelector.SpotlightSelector.__init__ | ( | ) |
Reimplemented from UiSelector.UiSelector.
| SpotlightSelector.SpotlightSelector.setSize | ( | ) |
Returns True if the sizing was actually modified.
Reimplemented from UiSelector.UiSelector.
| SpotlightSelector.SpotlightSelector.getSize | ( | ) |
| SpotlightSelector.SpotlightSelector.setRegion | ( | ) |
| SpotlightSelector.SpotlightSelector.getRegion | ( | ) |
| SpotlightSelector.SpotlightSelector.popupMenu | ( | ) |
There is no popup menu in this UI.
| SpotlightSelector.SpotlightSelector.highlight | ( | ) |
There is no highlighting in this overlay.
| SpotlightSelector.SpotlightSelector.select | ( | ) |
There is no selection in this overlay.
| SpotlightSelector.SpotlightSelector.release | ( | ) |
Called on a mouse up event.
| SpotlightSelector.SpotlightSelector.scrollUp | ( | ) |
| SpotlightSelector.SpotlightSelector.scrollDown | ( | ) |
| SpotlightSelector.SpotlightSelector.ConvertScreenToLogical | ( | ) |
Convert screen space coordinates to logical coordinate range vertical range 0.0 to 1.0, horizontal based off vertical with 0.0 being the center of the screen.
| SpotlightSelector.SpotlightSelector.ConvertLogicalToScreen | ( | ) |
Convert logical space coordinates to screen space coordinates Logical puts 0,0 in the middle of the bottom edge, with the height equalling 1.
| SpotlightSelector.SpotlightSelector.SetLock | ( | ) |
Locking the spotlight disallows changes to the spotlight such as position and size.
| SpotlightSelector.SpotlightSelector.isLocked | ( | ) |
| SpotlightSelector.SpotlightSelector.SetSpotCenter | ( | ) |
Sets the center position of the spotlight, as a logical range of the screen.
| SpotlightSelector.SpotlightSelector.GetSpotCenter | ( | ) |
Gets the center position of the spotlight, as a logical range of the screen.
| SpotlightSelector.SpotlightSelector.SetSpotScaleFactor | ( | ) |
Sets how much to scale the spotlight from the default image size.
| SpotlightSelector.SpotlightSelector.IncreaseSpotScaleFactor | ( | ) |
Expand the size of the spotlight.
| SpotlightSelector.SpotlightSelector.DecreaseSpotScaleFactor | ( | ) |
Contract the size of the spotlight.
| SpotlightSelector.SpotlightSelector.getSpotlightDimensionsInScreenSpace | ( | ) |
Returns the spotlight diameter and radius in screen coordinates.
| SpotlightSelector.SpotlightSelector.getSpotlightCenterInScreenSpace | ( | ) |
Returns the spotlight center in screen coordinates.
| SpotlightSelector.SpotlightSelector.MousePositionChanged | ( | ) |
Updates the spotlight location based on the mouse position.
| SpotlightSelector.SpotlightSelector.SendStateMessages | ( | ) |
| SpotlightSelector.SpotlightSelector.PositionLetterbox | ( | ) |
Letterbox the spotlight area and then fill the center with the spotlight image.
