Tool to display current scene orientation and to provide pre-defined camera positions
Constructor for a new SceneOrientationTool.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.ui.vk.tools.SceneOrientationTool(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID of the new tool instance. |
|
mSettings? | object | An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. |
Name | Type | Default Value | Description |
---|---|---|---|
active | boolean | false | Used to control the tool rendering and interaction pipeline. Visibility: public |
footprint | string[] | Used to decide whether this tool should be enabled for the target viewport. Visibility: public |
|
targetViewportType | any | Visibility: public | |
toolid | string | GUID identifier for the tool to prevent naming conflicts. Visibility: public |
Name | Cardinality | Type | Description |
---|---|---|---|
gizmo | 0..1 | sap.ui.vk.tools.Gizmo |
sap.ui.vk.tools.Gizmo owned by this control and used for rendering floating UI |
Method | Description |
---|---|
sap.ui.vk.tools.SceneOrientationTool.extend |
Creates a new subclass of class sap.ui.vk.tools.SceneOrientationTool with name
|
getEnableInitialView |
Gets current value of property enableInitialView. Default value is |
getEnablePredefinedViews |
Gets current value of property enablePredefinedViews. Default value is |
sap.ui.vk.tools.SceneOrientationTool.getMetadata |
Returns a metadata object for class sap.ui.vk.tools.SceneOrientationTool. |
queueCommand |
MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should be called using this method. |
setEnableInitialView |
Sets a new value for property enableInitialView. When called with a value of Default value is |
setEnablePredefinedViews |
Sets a new value for property enablePredefinedViews. When called with a value of Default value is |
setView |
Performs camera "fly to" animation to the predefined view. |
Creates a new subclass of class sap.ui.vk.tools.SceneOrientationTool with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.ui.vk.tools.Tool.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Gets current value of property enablePredefinedViews.
Default value is true
.
Returns a metadata object for class sap.ui.vk.tools.SceneOrientationTool.
MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should be called using this method.
Param | Type | DefaultValue | Description |
---|---|---|---|
command | function |
The command to be executed. |
Sets a new value for property enableInitialView.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bEnableInitialView | boolean | true |
New value for property |
Sets a new value for property enablePredefinedViews.
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is true
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bEnablePredefinedViews | boolean | true |
New value for property |
Performs camera "fly to" animation to the predefined view.
Param | Type | DefaultValue | Description |
---|---|---|---|
view | sap.ui.vk.tools.PredefinedView |
Predefined view. |
|
milliseconds | number |
Time to perform the "fly to" animation. |