Interface: Image360Collection<T>
Defined in: packages/360-images/src/collection/Image360Collection.ts:96
A wrapper that represents a set of 360 images.
Type Parameters
T
T extends DataSourceType = ClassicDataSourceType
Properties
id
readonlyid:string
Defined in: packages/360-images/src/collection/Image360Collection.ts:101
The id of the collection.
Returns
The id of the collection.
image360Entities
readonlyimage360Entities:Image360<T>[]
Defined in: packages/360-images/src/collection/Image360Collection.ts:112
A list containing all the 360 images in this set.
label
readonlylabel:undefined|string
Defined in: packages/360-images/src/collection/Image360Collection.ts:107
The label of the collection.
Returns
The label of the collection.
targetRevisionDate
targetRevisionDate:
undefined|Date
Defined in: packages/360-images/src/collection/Image360Collection.ts:118
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.
Methods
findImageAnnotations()
findImageAnnotations(
filter):Promise<Image360AnnotationAssetQueryResult<T>[]>
Defined in: packages/360-images/src/collection/Image360Collection.ts:217
Find 360 images associated with an asset through CDF annotations
Parameters
filter
Image360AnnotationAssetFilter<T>
Returns
Promise<Image360AnnotationAssetQueryResult<T>[]>
getAnnotationsInfo()
Call Signature
getAnnotationsInfo(
source):Promise<AssetAnnotationImage360Info<DataSourceType>[]>
Defined in: packages/360-images/src/collection/Image360Collection.ts:229
Fetches annotations from all available sources
Parameters
source
"all"
Returns
Promise<AssetAnnotationImage360Info<DataSourceType>[]>
Call Signature
getAnnotationsInfo(
source):Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[]>
Defined in: packages/360-images/src/collection/Image360Collection.ts:233
Fetches annotations from the CDF Annotation APIs, which are linked to CDF assets
Parameters
source
"assets"
Returns
Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[]>
Call Signature
getAnnotationsInfo(
source):Promise<AssetHybridAnnotationImage360Info[]>
Defined in: packages/360-images/src/collection/Image360Collection.ts:238
Fetches annotations from the CDF Core Data Model
Parameters
source
"hybrid"
Returns
Promise<AssetHybridAnnotationImage360Info[]>
Call Signature
getAnnotationsInfo(
source):Promise<AssetAnnotationImage360Info<DMDataSourceType>[]>
Defined in: packages/360-images/src/collection/Image360Collection.ts:243
Fetches annotations from the CDF Core Data Model
Parameters
source
"cdm"
Returns
Promise<AssetAnnotationImage360Info<DMDataSourceType>[]>
Call Signature
getAnnotationsInfo(
source):Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[] |AssetHybridAnnotationImage360Info[] |AssetAnnotationImage360Info<DMDataSourceType> |AssetAnnotationImage360Info<DataSourceType>[]>
Defined in: packages/360-images/src/collection/Image360Collection.ts:250
Get info of assets and annotations associated with this 360 image collection through various sources
Parameters
source
What source data to pull the annotation info from. Must be 'asset', 'cdm' or 'all'
"cdm" | "all" | "assets" | "hybrid"
Returns
Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[] | AssetHybridAnnotationImage360Info[] | AssetAnnotationImage360Info<DMDataSourceType> | AssetAnnotationImage360Info<DataSourceType>[]>
getAssetIds()
getAssetIds():
Promise<IdEither[]>
Defined in: packages/360-images/src/collection/Image360Collection.ts:224
Get IDs of all CDF assets associated with this 360 image collection through CDF annotations
Returns
Promise<IdEither[]>
Deprecated
Use ['getAnnotationsInfo']
getDefaultAnnotationStyle()
getDefaultAnnotationStyle():
Image360AnnotationAppearance
Defined in: packages/360-images/src/collection/Image360Collection.ts:207
Get the assigned default style affecting all annotations
Returns
getIconsOpacity()
getIconsOpacity():
number
Defined in: packages/360-images/src/collection/Image360Collection.ts:178
Get the opacity of the icons
Returns
number
The opacity of the icons
getIconsVisibility()
getIconsVisibility():
boolean
Defined in: packages/360-images/src/collection/Image360Collection.ts:142
Gets visibility of all 360 image icons.
Returns
boolean
true if all icons are visible, false if all icons are invisible
getImagesOpacity()
getImagesOpacity():
number
Defined in: packages/360-images/src/collection/Image360Collection.ts:166
Get the opacity of the images
Returns
number
The opacity of the images
getModelTransformation()
getModelTransformation(
out?):Matrix4
Defined in: packages/360-images/src/collection/Image360Collection.ts:129
Gets the transformation matrix of the collection
Parameters
out?
Matrix4
Returns
Matrix4
isOccludedIconsVisible()
isOccludedIconsVisible():
boolean
Defined in: packages/360-images/src/collection/Image360Collection.ts:154
Check if the occluded icons are visible
Returns
boolean
true is occluded icons are visible
off()
Call Signature
off(
event,callback):void
Defined in: packages/360-images/src/collection/Image360Collection.ts:201
Unsubscribes from 360 image dataset event.
Parameters
event
"image360Entered"
The event type.
callback
Callback function to be unsubscribed.
Returns
void
Call Signature
off(
event,callback):void
Defined in: packages/360-images/src/collection/Image360Collection.ts:202
Parameters
event
"image360Exited"
callback
Returns
void
on()
Call Signature
on(
event,callback):void
Defined in: packages/360-images/src/collection/Image360Collection.ts:193
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
Callback to be called when the event is fired.
Returns
void
Call Signature
on(
event,callback):void
Defined in: packages/360-images/src/collection/Image360Collection.ts:194
Parameters
event
"image360Exited"
callback
Returns
void
set360IconCullingRestrictions()
set360IconCullingRestrictions(
radius,pointLimit):void
Defined in: packages/360-images/src/collection/Image360Collection.ts:136
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
setDefaultAnnotationStyle()
setDefaultAnnotationStyle(
appearance):void
Defined in: packages/360-images/src/collection/Image360Collection.ts:212
Assign a default style which affects all annotations
Parameters
appearance
Returns
void
setIconsOpacity()
setIconsOpacity(
opacity):void
Defined in: packages/360-images/src/collection/Image360Collection.ts:184
Set the opacity of the icons
Parameters
opacity
number
The opacity of the icons
Returns
void
setIconsVisibility()
setIconsVisibility(
visible):void
Defined in: packages/360-images/src/collection/Image360Collection.ts:148
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
setImagesOpacity()
setImagesOpacity(
opacity):void
Defined in: packages/360-images/src/collection/Image360Collection.ts:172
Set the opacity of the images
Parameters
opacity
number
The opacity of the images
Returns
void
setModelTransformation()
setModelTransformation(
matrix):void
Defined in: packages/360-images/src/collection/Image360Collection.ts:124
Sets the transformation matrix to be applied to the collection.
Parameters
matrix
Matrix4
The transformation matrix to be applied to the collection.
Returns
void
setOccludedIconsVisible()
setOccludedIconsVisible(
visible):void
Defined in: packages/360-images/src/collection/Image360Collection.ts:160
Set the occluded icons visible
Parameters
visible
boolean
Returns
void