Provides a base loader interface.
To load content a concrete loader class is to be used.
Constructor for a new ContentManager.
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.ContentManager(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new ContentManager object. Generated automatically if no ID is given. |
|
mSettings? | object | Initial settings for the new ContentManager object. |
Event | Description |
---|---|
contentChangesFinished |
This event will be fired when content resources have been loaded successfully or with a failure. |
contentChangesProgress |
This event will be fired to report the progress of content changes. |
contentChangesStarted |
This event will be fired when content resources are about to be loaded. |
contentLoadingFinished |
This event will be fired when content loading is finished. |
This event will be fired when content resources have been loaded successfully or with a failure.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
content | any |
The content created or updated. |
failureReason | object |
The failure reason if any.
|
This event will be fired to report the progress of content changes.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
phase | string |
The name of the loading phase. It can be e.g. 'downloading', 'building the scene' etc. It might be null if reporting this parameter does not make sense. |
percentage | float |
The overall percentage of the loading process. |
source | any |
The content resource currently being loaded. It might be null if reporting this parameter does not make sense. |
Method | Description |
---|---|
attachContentChangesFinished |
Attaches event handler When called, the context of the event handler (its This event will be fired when content resources have been loaded successfully or with a failure. |
attachContentChangesProgress |
Attaches event handler When called, the context of the event handler (its This event will be fired to report the progress of content changes. |
attachContentChangesStarted |
Attaches event handler When called, the context of the event handler (its This event will be fired when content resources are about to be loaded. |
attachContentLoadingFinished |
Attaches event handler When called, the context of the event handler (its This event will be fired when content loading is finished. |
collectGarbage |
Collects and destroys unused objects and resources. |
createOrthographicCamera |
Creates a Perspective camera |
createPerspectiveCamera |
Creates a Orthographic camera |
destroyCamera |
Destroys a camera for the content type |
destroyContent |
Destroys the content. |
detachContentChangesFinished |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachContentChangesProgress |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachContentChangesStarted |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
detachContentLoadingFinished |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.vk.ContentManager.extend |
Creates a new subclass of class sap.ui.vk.ContentManager with name
|
fireContentChangesFinished |
Fires event contentChangesFinished to attached listeners. |
fireContentChangesProgress |
Fires event contentChangesProgress to attached listeners. |
fireContentChangesStarted |
Fires event contentChangesStarted to attached listeners. |
fireContentLoadingFinished |
Fires event contentLoadingFinished to attached listeners. |
sap.ui.vk.ContentManager.getMetadata |
Returns a metadata object for class sap.ui.vk.ContentManager. |
loadContent |
Starts downloading and building or updating the content from the content resources. This method is asynchronous. |
setRetryCount |
Sets the maximum number of retry attempts for a download operation if the initial request to retrieve a model from a remote server could not be fulfilled and the error with which the request failed is considered recoverable. See sap.ui.vk.ContentConnector#setRetryCount for details. |
Attaches event handler fnFunction
to the contentChangesFinished event of this sap.ui.vk.ContentManager
.
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.ContentManager
itself.
This event will be fired when content resources have been loaded successfully or with a failure.
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 |
Attaches event handler fnFunction
to the contentChangesProgress event of this sap.ui.vk.ContentManager
.
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.ContentManager
itself.
This event will be fired to report the progress of content changes.
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 |
Attaches event handler fnFunction
to the contentChangesStarted event of this sap.ui.vk.ContentManager
.
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.ContentManager
itself.
This event will be fired when content resources are about to be loaded.
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 |
Attaches event handler fnFunction
to the contentLoadingFinished event of this sap.ui.vk.ContentManager
.
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.ContentManager
itself.
This event will be fired when content loading is finished.
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 |
Destroys a camera for the content type
Param | Type | DefaultValue | Description |
---|---|---|---|
camera | any |
The camera to destroy. |
Destroys the content.
Param | Type | DefaultValue | Description |
---|---|---|---|
content | any |
The content to destroy. |
Detaches event handler fnFunction
from the contentChangesFinished event of this sap.ui.vk.ContentManager
.
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 |
Detaches event handler fnFunction
from the contentChangesProgress event of this sap.ui.vk.ContentManager
.
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 |
Detaches event handler fnFunction
from the contentChangesStarted event of this sap.ui.vk.ContentManager
.
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 |
Detaches event handler fnFunction
from the contentLoadingFinished event of this sap.ui.vk.ContentManager
.
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 |
Creates a new subclass of class sap.ui.vk.ContentManager 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.base.ManagedObject.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 |
Fires event contentChangesFinished to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
content | any |
The content created or updated. |
|
failureReason | object |
The failure reason if any.
|
Fires event contentChangesProgress to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
phase | string |
The name of the loading phase. It can be e.g. 'downloading', 'building the scene' etc. It might be null if reporting this parameter does not make sense. |
|
percentage | float |
The overall percentage of the loading process. |
|
source | any |
The content resource currently being loaded. It might be null if reporting this parameter does not make sense. |
Fires event contentChangesStarted to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
Fires event contentLoadingFinished to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
source | any | ||
node | any |
Starts downloading and building or updating the content from the content resources.
This method is asynchronous.
Param | Type | DefaultValue | Description |
---|---|---|---|
content | any |
The current content to update. It can be |
|
contentResources | sap.ui.vk.ContentResource[] |
The content resources to load or update. |
Sets the maximum number of retry attempts for a download operation if the initial request to retrieve a model from a remote server could not be fulfilled and the error with which the request failed is considered recoverable.
See sap.ui.vk.ContentConnector#setRetryCount for details.
Param | Type | DefaultValue | Description |
---|---|---|---|
retryCount | int |
Maximum number of retry attempts. Value must be non-negative. The default number of retry attempts is 1, unless specified otherwise by calling this method and passing in the desired value. Specifying 0 disables any retry attempts. |