Interface: Image360Collection<T>
A wrapper that represents a set of 360 images.
Type Parameters
• T extends DataSourceType = ClassicDataSourceType
Properties
id
readonlyid:string
The id of the collection.
Returns
The id of the collection.
Defined in
packages/360-images/src/collection/Image360Collection.ts:78
image360Entities
readonlyimage360Entities:Image360<T>[]
A list containing all the 360 images in this set.
Defined in
packages/360-images/src/collection/Image360Collection.ts:89
label
readonlylabel:undefined|string
The label of the collection.
Returns
The label of the collection.
Defined in
packages/360-images/src/collection/Image360Collection.ts:84
targetRevisionDate
targetRevisionDate:
undefined|Date
If defined, any subsequently entered 360 images will load the revision that are closest to the target date. If undefined, the most recent revision will be loaded.
Defined in
packages/360-images/src/collection/Image360Collection.ts:95
Methods
findImageAnnotations()
findImageAnnotations(
filter):Promise<Image360AnnotationAssetQueryResult<T>[]>
Find 360 images associated with an asset through CDF annotations
Parameters
• filter: Image360AnnotationAssetFilter<T>
Returns
Promise<Image360AnnotationAssetQueryResult<T>[]>
Defined in
packages/360-images/src/collection/Image360Collection.ts:194
getAnnotationsInfo()
getAnnotationsInfo(source)
getAnnotationsInfo(
source):Promise<AssetAnnotationImage360Info<DataSourceType>[]>
Fetches annotations from all available sources
Parameters
• source: "all"
Returns
Promise<AssetAnnotationImage360Info<DataSourceType>[]>
Defined in
packages/360-images/src/collection/Image360Collection.ts:206
getAnnotationsInfo(source)
getAnnotationsInfo(
source):Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[]>
Fetches annotations from the CDF Annotation APIs, which are linked to CDF assets
Parameters
• source: "assets"
Returns
Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[]>
Defined in
packages/360-images/src/collection/Image360Collection.ts:210
getAnnotationsInfo(source)
getAnnotationsInfo(
source):Promise<AssetAnnotationImage360Info<DMDataSourceType>[]>
Fetches annotations from the CDF Core Data Model
Parameters
• source: "cdm"
Returns
Promise<AssetAnnotationImage360Info<DMDataSourceType>[]>
Defined in
packages/360-images/src/collection/Image360Collection.ts:214
getAnnotationsInfo(source)
getAnnotationsInfo(
source):Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[] |AssetAnnotationImage360Info<DMDataSourceType> |AssetAnnotationImage360Info<DataSourceType>[]>
Get info of assets and annotations associated with this 360 image collection through various sources
Parameters
• source: "cdm" | "all" | "assets"
What source data to pull the annotation info from. Must be 'asset', 'cdm' or 'all'
Returns
Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[] | AssetAnnotationImage360Info<DMDataSourceType> | AssetAnnotationImage360Info<DataSourceType>[]>
Defined in
packages/360-images/src/collection/Image360Collection.ts:221
getAssetIds()
getAssetIds():
Promise<IdEither[]>
Get IDs of all CDF assets associated with this 360 image collection through CDF annotations
Returns
Promise<IdEither[]>
Deprecated
Defined in
packages/360-images/src/collection/Image360Collection.ts:201
getDefaultAnnotationStyle()
getDefaultAnnotationStyle():
Image360AnnotationAppearance
Get the assigned default style affecting all annotations
Returns
Defined in
packages/360-images/src/collection/Image360Collection.ts:184
getIconsOpacity()
getIconsOpacity():
number
Get the opacity of the icons
Returns
number
The opacity of the icons
Defined in
packages/360-images/src/collection/Image360Collection.ts:155
getIconsVisibility()
getIconsVisibility():
boolean
Gets visibility of all 360 image icons.
Returns
boolean
true if all icons are visible, false if all icons are invisible
Defined in
packages/360-images/src/collection/Image360Collection.ts:119
getImagesOpacity()
getImagesOpacity():
number
Get the opacity of the images
Returns
number
The opacity of the images
Defined in
packages/360-images/src/collection/Image360Collection.ts:143
getModelTransformation()
getModelTransformation(
out?):Matrix4
Gets the transformation matrix of the collection
Parameters
• out?: Matrix4
Returns
Matrix4
Defined in
packages/360-images/src/collection/Image360Collection.ts:106
isOccludedIconsVisible()
isOccludedIconsVisible():
boolean
Check if the occluded icons are visible
Returns
boolean
true is occluded icons are visible
Defined in
packages/360-images/src/collection/Image360Collection.ts:131
off()
off(event, callback)
off(
event,callback):void
Unsubscribes from 360 image dataset event.
Parameters
• event: "image360Entered"
The event type.
• callback: Image360EnteredDelegate<T>
Callback function to be unsubscribed.
Returns
void
Defined in
packages/360-images/src/collection/Image360Collection.ts:178
off(event, callback)
off(
event,callback):void
Parameters
• event: "image360Exited"
• callback: Image360ExitedDelegate
Returns
void
Defined in
packages/360-images/src/collection/Image360Collection.ts:179
on()
on(event, callback)
on(
event,callback):void
Subscribes to events on 360 Image datasets. There are several event types: 'image360Entered' - Subscribes to a event for entering 360 image mode. 'image360Exited' - Subscribes to events indicating 360 image mode has exited.
Parameters
• event: "image360Entered"
The event type.
• callback: Image360EnteredDelegate<T>
Callback to be called when the event is fired.
Returns
void
Defined in
packages/360-images/src/collection/Image360Collection.ts:170
on(event, callback)
on(
event,callback):void
Parameters
• event: "image360Exited"
• callback: Image360ExitedDelegate
Returns
void
Defined in
packages/360-images/src/collection/Image360Collection.ts:171
set360IconCullingRestrictions()
set360IconCullingRestrictions(
radius,pointLimit):void
Specify parameters used to determine the number of icons that are visible when entering 360 Images.
Parameters
• radius: number
Only icons within the given radius will be made visible.
• pointLimit: number
Limit the number of points within the given radius. Points closer to the camera will be prioritized.
Returns
void
Defined in
packages/360-images/src/collection/Image360Collection.ts:113
setDefaultAnnotationStyle()
setDefaultAnnotationStyle(
appearance):void
Assign a default style which affects all annotations
Parameters
• appearance: Image360AnnotationAppearance
Returns
void
Defined in
packages/360-images/src/collection/Image360Collection.ts:189
setIconsOpacity()
setIconsOpacity(
opacity):void
Set the opacity of the icons
Parameters
• opacity: number
The opacity of the icons
Returns
void
Defined in
packages/360-images/src/collection/Image360Collection.ts:161
setIconsVisibility()
setIconsVisibility(
visible):void
Set visibility of all 360 image icons.
Parameters
• visible: boolean
If true all icons are made visible according to the active culling scheme. If false all icons are hidden.
Returns
void
Defined in
packages/360-images/src/collection/Image360Collection.ts:125
setImagesOpacity()
setImagesOpacity(
opacity):void
Set the opacity of the images
Parameters
• opacity: number
The opacity of the images
Returns
void
Defined in
packages/360-images/src/collection/Image360Collection.ts:149
setModelTransformation()
setModelTransformation(
matrix):void
Sets the transformation matrix to be applied to the collection.
Parameters
• matrix: Matrix4
The transformation matrix to be applied to the collection.
Returns
void
Defined in
packages/360-images/src/collection/Image360Collection.ts:101
setOccludedIconsVisible()
setOccludedIconsVisible(
visible):void
Set the occluded icons visible
Parameters
• visible: boolean
Returns
void
Defined in
packages/360-images/src/collection/Image360Collection.ts:137