This tool provides rectangular selection
Constructor for a new RectSelectTool tool.
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.RectSelectTool(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.RectSelectTool.extend |
Creates a new subclass of class sap.ui.vk.tools.RectSelectTool with name
|
sap.ui.vk.tools.RectSelectTool.getMetadata |
Returns a metadata object for class sap.ui.vk.tools.RectSelectTool. |
getSubtractMode |
Gets current value of property subtractMode. If set to true then this tool will remove selected nodes from the selection set. Default is to always add them to the selection Default value is |
select |
Find all objects fully contained inside of specified rectangle |
setSubtractMode |
Sets a new value for property subtractMode. If set to true then this tool will remove selected nodes from the selection set. Default is to always add them to the selection When called with a value of Default value is |
Creates a new subclass of class sap.ui.vk.tools.RectSelectTool 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 |
Returns a metadata object for class sap.ui.vk.tools.RectSelectTool.
Gets current value of property subtractMode.
If set to true then this tool will remove selected nodes from the selection set. Default is to always add them to the selection
Default value is false
.
Find all objects fully contained inside of specified rectangle
Param | Type | DefaultValue | Description |
---|---|---|---|
x1 | int |
x coordinate of top-left/bottom-right corner of selection rectangle. |
|
y1 | int |
y coordinate of top-left/bottom-right corner of selection rectangle. |
|
x2 | int |
x coordinate of bottom-right/top-left corner of selection rectangle. |
|
y2 | int |
y coordinate of bottom-right/top-left corner of selection rectangle. |
|
scene | sap.ui.vk.Scene |
Scene object used in current viewport. |
|
camera | sap.ui.vk.Camera |
Current viewport's camera. |
Sets a new value for property subtractMode.
If set to true then this tool will remove selected nodes from the selection set. Default is to always add them to the selection
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is false
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bSubtractMode | boolean | false |
New value for property |