src

Last update: 2023-11-03
  • Created for:
  • Developer
    User

Material file. Specifies material data, either in form of a single material catalog reference, or as one or two image or material data files, separated with a comma.

src = *catalogEntry*|{{ *materialFile*| *embeddedReq*}[, *materialFile*]

srcE= *name*

srcN= *index*

catalogEntry

[/][ catId/] recId

materialFile

styleFile| imageFile

embeddedReq

{'is{' isReq'}'}|{'ir{' irReq'}'|{'{' foreignReq'}'

catId

Material catalog ID ( attribute::RootId).

recId

Material catalog entry ( catalog::Id).

styleFile

Material style file ( .vnc or .vnw).

imageFile

Image data file.

isReq

Request to Image Serving.

irReq

Request to Image Rendering.

foreignReq

Request to a foreign server.

name

Name of an embedded material.

index

0-based index number for an embedded material.

Repeatable Texture, Decal, and Wallpaper materials require a single image, which may be specified as a file or an embedded request.

Cabinet materials require a cabinet style file ( .vnc), which cannot be specified as a nested request. A texture image file is optional for cabinets, and, if specified, it may be either a file or an embedded request.

Window coverings materials require a window coverings style file ( .vnw), which cannot be specified as a nested request. A texture file is optional and, if specified, it may be either a file or an embedded request.

Image Rendering uses the same rules as Image Serving for looking up material catalogs, catalog entries, and data files. Refer to the description of the object Data Type in the Image Serving documentation for details.

materialFile Is a path relative to attribute::RootPath.

foreignReq Can either be a URL relative to attribute::RootUrl, or an absolute URL if attribute::AllowDirectUrls is set.

If catId is not specified, the session catalog is used.

srcE= and srcN= provide access to materials embedded in the vignette.

Supported file formats

Image Rendering supports the same source image formats as Dynamic Media Image Serving.

Applications which require image data in multiple different resolutions perform best when using the Scene7 pyramid TIFF (PTIFF) multi-resolution format. Image Serving includes the Image Converter (IC) utility which creates PTIFF images from any supported format.

Refer to the description of the IC utility in the Image Serving documentation for a complete list of supported file formats.

Properties

Material attribute. Required for all materials except solid color (not permitted for solid color materials). All strings are case-sensitive. index Must be 0 or larger.

Default

None.

Example

An MSS for a colorized cabinet with a separate repeatable texture:

…&obj=cabinets&src=cabs/maple02.vnc,cabs/maple.jpg&res=40&color=185,105,35&…

The same material could be in a material catalog 'cat’ in record ’ 12-3-2’:

…&obj=cabinets&src=cat/12-3-2&…

A nested request to Image Serving to obtain a texture image:

…&obj=main&src=is{texCatalog/texture123?res=30}&res=30&…

See also

Material Catalogs, attribute::RootUrl, attribute::AllowDirectUrls

On this page