class sap.ui.vk.tools.CreatePathTool

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vk/tools/CreatePathTool
Application Component: CA-UI5-VTK

The CreatePathTool allows applications to create a path svg element.


Constructor

Constructor for a new CreatePathTool.

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.CreatePathTool(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID of the new tool instance. sIdis generated automatically if no non-empty ID is given. Note: this can be omitted, regardless of whether mSettings will be provided or not.

mSettings? object

An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance.


Properties

Name Type Default Value Description
closePath boolean false

Flag to always create closed path elements.

Visibility: public
parentNode any

Parent node for new elements.

Visibility: public

Borrowed Properties

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

Borrowed Aggregations

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


Events Overview

Event Description
completed

Fired when a new element is created.

completed

Fired when a new element is created.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
node any

Created node.

node.sid - node's sid node.nodeContentType - node content type node.materialId - assigned material sid node.name - node's name node.matrix - node transformation matrix node.parametric - index of created parametric object in parametrics array

request any

Request payload for a storage server to create a parametric primitive.

closed boolean

Indicates whether the created path is closed.


Methods Overview

Method Description
attachCompleted

Attaches event handler fnFunction to the completed event of this sap.ui.vk.tools.CreatePathTool.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.tools.CreatePathTool itself.

Fired when a new element is created.

detachCompleted

Detaches event handler fnFunction from the completed event of this sap.ui.vk.tools.CreatePathTool.

The passed function and listener object must match the ones used for event registration.

sap.ui.vk.tools.CreatePathTool.extend

Creates a new subclass of class sap.ui.vk.tools.CreatePathTool 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.

fireCompleted

Fires event completed to attached listeners.

getClosePath

Gets current value of property closePath.

Flag to always create closed path elements.

Default value is false.

sap.ui.vk.tools.CreatePathTool.getMetadata

Returns a metadata object for class sap.ui.vk.tools.CreatePathTool.

getParentNode

Gets current value of property parentNode.

Parent node for new elements.

queueCommand

MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should be called using this method.

setClosePath

Sets a new value for property closePath.

Flag to always create closed path elements.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

setParentNode

Sets a new value for property parentNode.

Parent node for new elements.

When called with a value of null or undefined, the default value of the property will be restored.

attachCompleted

Attaches event handler fnFunction to the completed event of this sap.ui.vk.tools.CreatePathTool.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.vk.tools.CreatePathTool itself.

Fired when a new element is created.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.vk.tools.CreatePathTool itself

detachCompleted

Detaches event handler fnFunction from the completed event of this sap.ui.vk.tools.CreatePathTool.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.vk.tools.CreatePathTool.extend

Creates a new subclass of class sap.ui.vk.tools.CreatePathTool 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

fireCompleted

Fires event completed to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

node any

Created node.

node.sid - node's sid node.nodeContentType - node content type node.materialId - assigned material sid node.name - node's name node.matrix - node transformation matrix node.parametric - index of created parametric object in parametrics array

request any

Request payload for a storage server to create a parametric primitive.

closed boolean

Indicates whether the created path is closed.

getClosePath

Gets current value of property closePath.

Flag to always create closed path elements.

Default value is false.

sap.ui.vk.tools.CreatePathTool.getMetadata

Returns a metadata object for class sap.ui.vk.tools.CreatePathTool.

getParentNode

Gets current value of property parentNode.

Parent node for new elements.

queueCommand

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.

setClosePath

Sets a new value for property closePath.

Flag to always create closed path elements.

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
bClosePath boolean false

New value for property closePath

setParentNode

Sets a new value for property parentNode.

Parent node for new elements.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
oParentNode any

New value for property parentNode