Model3DProviderInterface
in
Interface for 3D model viewer providers.
Plugins that provide 3D model viewing capabilities should implement this. Register via: AtomFramework\Providers::register('model_3d', $implementation)
Table of Contents
Methods
- generateThumbnail() : array<string|int, mixed>
- Generate a thumbnail for a 3D model.
- getSupportedFormats() : array<string|int, mixed>
- Get supported 3D formats.
- getViewerConfig() : array<string|int, mixed>
- Get viewer configuration for 3D model.
- is3dModel() : bool
- Check if a digital object is a 3D model.
Methods
generateThumbnail()
Generate a thumbnail for a 3D model.
public
generateThumbnail(int $digitalObjectId[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $digitalObjectId : int
-
The digital object ID
- $options : array<string|int, mixed> = []
-
Thumbnail options (width, height, angle)
Return values
array<string|int, mixed> —['success' => bool, 'path' => ?string, 'error' => ?string]
getSupportedFormats()
Get supported 3D formats.
public
getSupportedFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of supported MIME types or extensions
getViewerConfig()
Get viewer configuration for 3D model.
public
getViewerConfig(int $digitalObjectId) : array<string|int, mixed>
Parameters
- $digitalObjectId : int
-
The digital object ID
Return values
array<string|int, mixed> —['viewer' => string, 'config' => array, 'formats' => array]
is3dModel()
Check if a digital object is a 3D model.
public
is3dModel(int $digitalObjectId) : bool
Parameters
- $digitalObjectId : int
-
The digital object ID