phpdftk API Documentation

ThreeDStream extends PdfStream
in package

3D stream (/Type /3D) — ISO 32000-2 §13.6.3.

Carries the 3D artwork (U3D or PRC bytes) referenced by a 3D annotation.

Required: Subtype (U3D or PRC). Optional: VA (views), DV (default view), AN (animation style), ColorSpace, Resources.

Attributes
#[RequiresPdfVersion]
\Phpdftk\Pdf\Core\PdfVersion::V1_6

Table of Contents

Constants

PDF_TYPE  = '3D'

Properties

$an  : PdfDictionary|null
$colorSpace  : ColorSpace|PdfName|PdfArray|null
$data  : string
$dictionary  : PdfDictionary
$dv  : mixed
$generationNumber  : int
$objectNumber  : int
$oncInstantiate  : PdfString|null
$resources  : PdfDictionary|null
$subtype  : PdfName
$va  : PdfArray|null

Methods

__construct()  : mixed
setFilter()  : void
Set a filter to encode/decode the stream data.
toIndirectObject()  : string
Wrap the object in an indirect object structure: X Y obj ... endobj
toPdf()  : string
Returns the stream body: dictionary, stream keyword, data, endstream.

Constants

Properties

$generationNumber

public int $generationNumber = 0

Methods

__construct()

public __construct(string $subtype[, string $bytes = '' ]) : mixed
Parameters
$subtype : string
$bytes : string = ''

setFilter()

Set a filter to encode/decode the stream data.

public setFilter(FilterInterface $filter, string $pdfFilterName) : void
Parameters
$filter : FilterInterface

The filter implementation

$pdfFilterName : string

The PDF filter name (e.g. 'FlateDecode', 'ASCII85Decode')

toIndirectObject()

Wrap the object in an indirect object structure: X Y obj ... endobj

public toIndirectObject() : string
Return values
string

toPdf()

Returns the stream body: dictionary, stream keyword, data, endstream.

public toPdf() : string

/Length is injected into the dictionary at serialization time. If a filter is set, the data is encoded before writing.

Return values
string

        
On this page

Search results