Specifies a resource to load.
Constructor for a new ContentResource.
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.ContentResource(sId?, mSettings?, oScope?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID of the new content resource. |
|
mSettings? | object | An optional map/JSON object with initial property values, aggregated objects etc. for the new content resource. |
|
oScope? | object | scope An object for resolving string-based type and formatter references in bindings. |
Name | Type | Default Value | Description |
---|---|---|---|
activateView | string | Optional parameter with view id which shall be activated when scene is loaded. Visibility: public |
|
enableLogger | boolean | false | Optional boolean parameter to enable detailed logging. Can be used to track performance issues during data streaming from SAP 3D Visualization Service. Visibility: public |
includeAnimation | boolean | true | Send structural data for animation objects, if false they will be omitted, reducing data size. Default: true. Visibility: public |
includeBackground | boolean | true | If set to true, will return nodes with the type background Visibility: public |
includeHidden | boolean | true | Send structural data for hidden objects, if false they will be omitted, reducing data size. Default: true. Visibility: public |
includeParametric | boolean | true | If set to true, will load parametric nodes Visibility: public |
includeUsageId | sap.ui.vk.IncludeUsageIdType | false | Optional parameter to load UsageIds. Valid values: true - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined for the tenant which are not relevant to the current application. false - Do not load any UsageIds. string - A single non-empty string which defines the name of the requested UsageId. string[] - An array of non-empty strings which define the names of requested UsageIds. Visibility: public |
localMatrix | sap.ui.vk.TransformationMatrix | The local transformation matrix of the node created for this content resource. Visibility: public |
|
metadataFilter | string | Optional metadata filter that can trim the tree before sending to the client only keeping nodes that passed the filter and their parents. Default: null. Format: Comma-separated list of meta.category1.tag1.value1, meta.category2.tag2.value2. "meta." is the prefix and all metadata filters must start with it. Multiple filters are supported, they are combined using `OR` operator. Includes parent nodes of matching nodes (e.g. breadcrumb) even if they don't pass the filter. Visibility: public |
|
name | string | The name of the node created for this content resource. Visibility: public |
|
password | string | The password to use when opening the resource. Visibility: public |
|
pushPMI | boolean | false | If set to true, elements for PMI rendering content will be returned. Default: false. Visibility: public |
pushViewGroups | boolean | true | If set to true, information of view groups will be returned. Default: true. Visibility: public |
source | any | The source URL or the File
|
|
sourceId | string | The unique ID of the content resource. Visibility: public |
|
sourceType | string | The source type of the content resource. Valid types:
|
|
useSecureConnection | boolean | true | If set to false, unsecure connections will be used. Default: true. Visibility: public |
veid | string | Id of scene to retrieve tree for. Mandatory for the stream source type. Visibility: public |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
contentResources | 0..n | sap.ui.vk.ContentResource |
Child content resources. |
Method | Description |
---|---|
addContentResource |
Adds some contentResource to the aggregation contentResources. |
sap.ui.vk.ContentResource.collectCategories |
Collects content resource categories. The result is tested if the content resource hierarchy has the same category - 2D or 3D. |
destroyContentResources |
Destroys all the contentResources in the aggregation contentResources. |
sap.ui.vk.ContentResource.extend |
Creates a new subclass of class sap.ui.vk.ContentResource with name
|
getActivateView |
Gets current value of property activateView. Optional parameter with view id which shall be activated when scene is loaded. |
getContentResources |
Gets content of aggregation contentResources. Child content resources. |
getEnableLogger |
Gets current value of property enableLogger. Optional boolean parameter to enable detailed logging. Can be used to track performance issues during data streaming from SAP 3D Visualization Service. Default value is |
getIncludeAnimation |
Gets current value of property includeAnimation. Send structural data for animation objects, if false they will be omitted, reducing data size. Default: true. Default value is |
getIncludeBackground |
Gets current value of property includeBackground. If set to true, will return nodes with the type background Default value is |
getIncludeHidden |
Gets current value of property includeHidden. Send structural data for hidden objects, if false they will be omitted, reducing data size. Default: true. Default value is |
getIncludeParametric |
Gets current value of property includeParametric. If set to true, will load parametric nodes Default value is |
getIncludeUsageId |
Gets current value of property includeUsageId. Optional parameter to load UsageIds. Valid values: true - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined for the tenant which are not relevant to the current application. false - Do not load any UsageIds. string - A single non-empty string which defines the name of the requested UsageId. string[] - An array of non-empty strings which define the names of requested UsageIds. Default value is |
getLocalMatrix |
Gets current value of property localMatrix. The local transformation matrix of the node created for this content resource. |
sap.ui.vk.ContentResource.getMetadata |
Returns a metadata object for class sap.ui.vk.ContentResource. |
getMetadataFilter |
Gets current value of property metadataFilter. Optional metadata filter that can trim the tree before sending to the client only keeping nodes that passed the filter and their parents. Default: null. Format: Comma-separated list of meta.category1.tag1.value1, meta.category2.tag2.value2. "meta." is the prefix and all metadata filters must start with it. Multiple filters are supported, they are combined using `OR` operator. Includes parent nodes of matching nodes (e.g. breadcrumb) even if they don't pass the filter. |
getName |
Gets current value of property name. The name of the node created for this content resource. |
getNodeProxy |
Gets the NodeProxy object created for this content resource. If this is the only top level content resource, the NodeProxy object is not set since the grouping node is not created, which means that there may be multiple top level nodes. |
getPassword |
Gets current value of property password. The password to use when opening the resource. |
getPushPMI |
Gets current value of property pushPMI. If set to true, elements for PMI rendering content will be returned. Default: false. Default value is |
getPushViewGroups |
Gets current value of property pushViewGroups. If set to true, information of view groups will be returned. Default: true. Default value is |
getSource |
Gets current value of property source. The source URL or the File
|
getSourceId |
Gets current value of property sourceId. The unique ID of the content resource. |
getSourceProperties |
Gets content resource source properties. The content resource source properties depend on the content resource source type. They are different for VDS and PNG for example. The list of possible source properties:
|
getSourceType |
Gets current value of property sourceType. The source type of the content resource. Valid types:
|
getUseSecureConnection |
Gets current value of property useSecureConnection. If set to false, unsecure connections will be used. Default: true. Default value is |
getVeid |
Gets current value of property veid. Id of scene to retrieve tree for. Mandatory for the stream source type. |
indexOfContentResource |
Checks for the provided |
insertContentResource |
Inserts a contentResource into the aggregation contentResources. |
removeAllContentResources |
Removes all the controls from the aggregation contentResources. Additionally, it unregisters them from the hosting UIArea. |
removeContentResource |
Removes a contentResource from the aggregation contentResources. |
setActivateView |
Sets a new value for property activateView. Optional parameter with view id which shall be activated when scene is loaded. When called with a value of |
setEnableLogger |
Sets a new value for property enableLogger. Optional boolean parameter to enable detailed logging. Can be used to track performance issues during data streaming from SAP 3D Visualization Service. When called with a value of Default value is |
setIncludeAnimation |
Sets a new value for property includeAnimation. Send structural data for animation objects, if false they will be omitted, reducing data size. Default: true. When called with a value of Default value is |
setIncludeBackground |
Sets a new value for property includeBackground. If set to true, will return nodes with the type background When called with a value of Default value is |
setIncludeHidden |
Sets a new value for property includeHidden. Send structural data for hidden objects, if false they will be omitted, reducing data size. Default: true. When called with a value of Default value is |
setIncludeParametric |
Sets a new value for property includeParametric. If set to true, will load parametric nodes When called with a value of Default value is |
setIncludeUsageId |
Sets a new value for property includeUsageId. Optional parameter to load UsageIds. Valid values: true - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined for the tenant which are not relevant to the current application. false - Do not load any UsageIds. string - A single non-empty string which defines the name of the requested UsageId. string[] - An array of non-empty strings which define the names of requested UsageIds. When called with a value of Default value is |
setLocalMatrix |
Sets a new value for property localMatrix. The local transformation matrix of the node created for this content resource. When called with a value of |
setMetadataFilter |
Sets a new value for property metadataFilter. Optional metadata filter that can trim the tree before sending to the client only keeping nodes that passed the filter and their parents. Default: null. Format: Comma-separated list of meta.category1.tag1.value1, meta.category2.tag2.value2. "meta." is the prefix and all metadata filters must start with it. Multiple filters are supported, they are combined using `OR` operator. Includes parent nodes of matching nodes (e.g. breadcrumb) even if they don't pass the filter. When called with a value of |
setName |
Sets a new value for property name. The name of the node created for this content resource. When called with a value of |
setPassword |
Sets a new value for property password. The password to use when opening the resource. When called with a value of |
setPushPMI |
Sets a new value for property pushPMI. If set to true, elements for PMI rendering content will be returned. Default: false. When called with a value of Default value is |
setPushViewGroups |
Sets a new value for property pushViewGroups. If set to true, information of view groups will be returned. Default: true. When called with a value of Default value is |
setSource |
Sets a new value for property source. The source URL or the File
When called with a value of |
setSourceId |
Sets a new value for property sourceId. The unique ID of the content resource. When called with a value of |
setSourceType |
Sets a new value for property sourceType. The source type of the content resource. Valid types:
When called with a value of |
setUseSecureConnection |
Sets a new value for property useSecureConnection. If set to false, unsecure connections will be used. Default: true. When called with a value of Default value is |
setVeid |
Sets a new value for property veid. Id of scene to retrieve tree for. Mandatory for the stream source type. When called with a value of |
Adds some contentResource to the aggregation contentResources.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContentResource | sap.ui.vk.ContentResource |
The contentResource to add; if empty, nothing is inserted |
Collects content resource categories. The result is tested if the content resource hierarchy has the same category - 2D or 3D.
Param | Type | DefaultValue | Description |
---|---|---|---|
resources | sap.ui.vk.ContentResource[] |
The array of content resources. |
Creates a new subclass of class sap.ui.vk.ContentResource 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 |
Gets current value of property activateView.
Optional parameter with view id which shall be activated when scene is loaded.
Gets current value of property enableLogger.
Optional boolean parameter to enable detailed logging. Can be used to track performance issues during data streaming from SAP 3D Visualization Service.
Default value is false
.
Gets current value of property includeAnimation.
Send structural data for animation objects, if false they will be omitted, reducing data size. Default: true.
Default value is true
.
Gets current value of property includeBackground.
If set to true, will return nodes with the type background
Default value is true
.
Gets current value of property includeHidden.
Send structural data for hidden objects, if false they will be omitted, reducing data size. Default: true.
Default value is true
.
Gets current value of property includeParametric.
If set to true, will load parametric nodes
Default value is true
.
Gets current value of property includeUsageId.
Optional parameter to load UsageIds. Valid values: true - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined for the tenant which are not relevant to the current application. false - Do not load any UsageIds. string - A single non-empty string which defines the name of the requested UsageId. string[] - An array of non-empty strings which define the names of requested UsageIds.
Default value is false
.
Gets current value of property localMatrix.
The local transformation matrix of the node created for this content resource.
Returns a metadata object for class sap.ui.vk.ContentResource.
Gets current value of property metadataFilter.
Optional metadata filter that can trim the tree before sending to the client only keeping nodes that passed the filter and their parents. Default: null. Format: Comma-separated list of meta.category1.tag1.value1, meta.category2.tag2.value2. "meta." is the prefix and all metadata filters must start with it. Multiple filters are supported, they are combined using `OR` operator. Includes parent nodes of matching nodes (e.g. breadcrumb) even if they don't pass the filter.
Gets the NodeProxy object created for this content resource.
If this is the only top level content resource, the NodeProxy object is not set since the grouping node is not created, which means that there may be multiple top level nodes.
Gets current value of property pushPMI.
If set to true, elements for PMI rendering content will be returned. Default: false.
Default value is false
.
Gets current value of property pushViewGroups.
If set to true, information of view groups will be returned. Default: true.
Default value is true
.
Gets current value of property source.
The source URL or the File
object of the content resource/file to load from. The source may be omitted if a grouping node is needed.
Gets content resource source properties.
The content resource source properties depend on the content resource source type. They are different for VDS and PNG for example. The list of possible source properties:
Gets current value of property sourceType.
The source type of the content resource. Valid types:
Gets current value of property useSecureConnection.
If set to false, unsecure connections will be used. Default: true.
Default value is true
.
Gets current value of property veid.
Id of scene to retrieve tree for. Mandatory for the stream source type.
Checks for the provided sap.ui.vk.ContentResource
in the aggregation contentResources. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContentResource | sap.ui.vk.ContentResource |
The contentResource whose index is looked for |
Inserts a contentResource into the aggregation contentResources.
Param | Type | DefaultValue | Description |
---|---|---|---|
oContentResource | sap.ui.vk.ContentResource |
The contentResource to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation contentResources.
Additionally, it unregisters them from the hosting UIArea.
Removes a contentResource from the aggregation contentResources.
Param | Type | DefaultValue | Description |
---|---|---|---|
vContentResource | int string sap.ui.vk.ContentResource |
The contentResource to remove or its index or id |
Sets a new value for property activateView.
Optional parameter with view id which shall be activated when scene is loaded.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sActivateView | string |
New value for property |
Sets a new value for property enableLogger.
Optional boolean parameter to enable detailed logging. Can be used to track performance issues during data streaming from SAP 3D Visualization Service.
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 |
---|---|---|---|
bEnableLogger | boolean | false |
New value for property |
Sets a new value for property includeAnimation.
Send structural data for animation objects, if false they will be omitted, reducing data size. Default: true.
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 |
---|---|---|---|
bIncludeAnimation | boolean | true |
New value for property |
Sets a new value for property includeBackground.
If set to true, will return nodes with the type background
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 |
---|---|---|---|
bIncludeBackground | boolean | true |
New value for property |
Sets a new value for property includeHidden.
Send structural data for hidden objects, if false they will be omitted, reducing data size. Default: true.
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 |
---|---|---|---|
bIncludeHidden | boolean | true |
New value for property |
Sets a new value for property includeParametric.
If set to true, will load parametric nodes
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 |
---|---|---|---|
bIncludeParametric | boolean | true |
New value for property |
Sets a new value for property includeUsageId.
Optional parameter to load UsageIds. Valid values: true - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined for the tenant which are not relevant to the current application. false - Do not load any UsageIds. string - A single non-empty string which defines the name of the requested UsageId. string[] - An array of non-empty strings which define the names of requested UsageIds.
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 |
---|---|---|---|
sIncludeUsageId | sap.ui.vk.IncludeUsageIdType | false |
New value for property |
Sets a new value for property localMatrix.
The local transformation matrix of the node created for this content resource.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sLocalMatrix | sap.ui.vk.TransformationMatrix |
New value for property |
Sets a new value for property metadataFilter.
Optional metadata filter that can trim the tree before sending to the client only keeping nodes that passed the filter and their parents. Default: null. Format: Comma-separated list of meta.category1.tag1.value1, meta.category2.tag2.value2. "meta." is the prefix and all metadata filters must start with it. Multiple filters are supported, they are combined using `OR` operator. Includes parent nodes of matching nodes (e.g. breadcrumb) even if they don't pass the filter.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sMetadataFilter | string |
New value for property |
Sets a new value for property name.
The name of the node created for this content resource.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sName | string |
New value for property |
Sets a new value for property password.
The password to use when opening the resource.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sPassword | string |
New value for property |
Sets a new value for property pushPMI.
If set to true, elements for PMI rendering content will be returned. Default: false.
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 |
---|---|---|---|
bPushPMI | boolean | false |
New value for property |
Sets a new value for property pushViewGroups.
If set to true, information of view groups will be returned. Default: true.
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 |
---|---|---|---|
bPushViewGroups | boolean | true |
New value for property |
Sets a new value for property source.
The source URL or the File
object of the content resource/file to load from. The source may be omitted if a grouping node is needed.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSource | any |
New value for property |
Sets a new value for property sourceId.
The unique ID of the content resource.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sSourceId | string |
New value for property |
Sets a new value for property sourceType.
The source type of the content resource. Valid types:
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sSourceType | string |
New value for property |
Sets a new value for property useSecureConnection.
If set to false, unsecure connections will be used. Default: true.
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 |
---|---|---|---|
bUseSecureConnection | boolean | true |
New value for property |
Sets a new value for property veid.
Id of scene to retrieve tree for. Mandatory for the stream source type.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sVeid | string |
New value for property |