The CrossSection tool can be used to cut all 3D objects along one of three spatial axis to expose their internal structures.
Constructor for a new CrossSectionTool.
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.CrossSectionTool(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.CrossSectionTool.extend |
Creates a new subclass of class sap.ui.vk.tools.CrossSectionTool with name
|
sap.ui.vk.tools.CrossSectionTool.getMetadata |
Returns a metadata object for class sap.ui.vk.tools.CrossSectionTool. |
getShowEditingUI |
Gets current value of property showEditingUI. Display text box with current value, which can also be used to directly modify the value Default value is |
queueCommand |
MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should be called using this method. |
setAxis |
Sets the clipping plane axis. |
setFlip |
Flips the clipping plane. |
setShowEditingUI |
Sets a new value for property showEditingUI. Display text box with current value, which can also be used to directly modify the value When called with a value of Default value is |
Creates a new subclass of class sap.ui.vk.tools.CrossSectionTool 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.CrossSectionTool.
Gets current value of property showEditingUI.
Display text box with current value, which can also be used to directly modify the value
Default value is false
.
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 the clipping plane axis.
Param | Type | DefaultValue | Description |
---|---|---|---|
index | number |
Axis index from 0 to 2: 0 - X, 1 - Y, 2 - Z. |
Flips the clipping plane.
Param | Type | DefaultValue | Description |
---|---|---|---|
flip | boolean |
If set to |
Sets a new value for property showEditingUI.
Display text box with current value, which can also be used to directly modify the value
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 |
---|---|---|---|
bShowEditingUI | boolean | false |
New value for property |