Heratio Framework API Reference

ThreeDThumbnailService
in package

Service for generating thumbnails from 3D model files (GLB, GLTF, OBJ, etc.)

Table of Contents

Methods

__construct()  : mixed
batchProcessExisting()  : array<string|int, mixed>
createDerivatives()  : bool
generateMultiAngle()  : array<string, string>
Generate 6 multi-angle renders of a 3D model via Blender.
generateThumbnail()  : bool
getMultiAngleDir()  : string
Get the multi-angle output directory for a digital object.
getSupportedMimeTypes()  : array<string|int, mixed>
is3DMimeType()  : bool
is3DModel()  : bool

Methods

batchProcessExisting()

public batchProcessExisting() : array<string|int, mixed>
Return values
array<string|int, mixed>

createDerivatives()

public createDerivatives(int $digitalObjectId) : bool
Parameters
$digitalObjectId : int
Return values
bool

generateMultiAngle()

Generate 6 multi-angle renders of a 3D model via Blender.

public generateMultiAngle(string $inputPath, string $outputDir[, int $size = 1024 ]) : array<string, string>
Parameters
$inputPath : string
$outputDir : string
$size : int = 1024
Return values
array<string, string>

Map of view name => file path (e.g. ['front' => '/path/front.png', ...])

generateThumbnail()

public generateThumbnail(string $inputPath, string $outputPath[, int $width = 512 ][, int $height = 512 ]) : bool
Parameters
$inputPath : string
$outputPath : string
$width : int = 512
$height : int = 512
Return values
bool

getMultiAngleDir()

Get the multi-angle output directory for a digital object.

public getMultiAngleDir(int $digitalObjectId) : string
Parameters
$digitalObjectId : int
Return values
string

getSupportedMimeTypes()

public getSupportedMimeTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

is3DMimeType()

public is3DMimeType(string $mime) : bool
Parameters
$mime : string
Return values
bool

is3DModel()

public is3DModel(string $filename) : bool
Parameters
$filename : string
Return values
bool

        
On this page

Search results