Material Effects

Published Updated
A suite of built-in material effects used to apply texture coordinates, engravings, reflections, and advanced shaders to 3D models and shapes in Aircada.

Material effects allow developers to alter the surface properties and visual appearance of 3D models and geometry within an experience.

By adding these effects to an object's material pipeline, you can customize properties like color maps, surface normal depth, holographic projections, engravings, and mirror-like reflections.

Engraving and Emboss Effect for 3D Materials#

Effect<EngravingEffect>: A material effect that projects custom textures as physical-looking engravings or embossments onto a surface, with color blending and coordinate bounds.

The Engraving effect projects high-quality images onto 3D surfaces as embossed or engraved designs, giving assets tangible depth.

It reads a texture file via the textureMediaItemId property and applies depth offsets through the depth parameter, which can be configured to carve inward (negative values) or emboss outward (positive values). Properties under the Texture and Placement groups like colorBlend, feather, proportionalScalar (Scale), textureOffsetX (Center X), textureOffsetY (Center Y), and uvRotation govern the visual blending, positioning, and rotation. Boundaries can be restricted using useBoundaries alongside xBoundaries and yBoundaries ranges, while emissive highlights are customized via emissiveIntensity, emissiveMap, and emissiveColor.

Engraving

XR_MATERIAL.AME_ENGRAVING_EFFECT
Effect
Effect System ID
AME_ENGRAVING_EFFECT
Pipeline Type
XR_MATERIAL
Context Type
XR_UNIT

Engraving Properties Details

Property & TypeDisplay NameSystem TypeDefault
textureMediaItemId: IMediaItem
Material
MEDIA_ITEM
ELEMENT SELECTOR
""
colorBlend: IColor
Color Blend
COLOR
COLOR PICKER
[1, 1, 1, 1]
replaceColor: boolean
Replace Color
BOOL
TOGGLE
false
feather: float
Feather
FLOAT
RANGE SLIDER
0.1
proportionalScalar: float
Scale
FLOAT
RANGE SLIDER
0.5
textureOffsetX: float
Center X
FLOAT
RANGE SLIDER
0.5
textureOffsetY: float
Center Y
FLOAT
RANGE SLIDER
0.5
uvRotation: float
Rotation
FLOAT
RANGE SLIDER
0
uvCorrectionAngle: float
Angle Correction
FLOAT
RANGE SLIDER
0
manualUVScaleX: float
UV Adjust X
FLOAT
RANGE SLIDER
1
manualUVScaleY: float
UV Adjust Y
FLOAT
RANGE SLIDER
1
useBoundaries: boolean
Use Bounds
BOOL
TOGGLE
false
xBoundaries: [number, number]
X Bounds
RANGE
RANGE SLIDER
[0, 1]
yBoundaries: [number, number]
Y Bounds
RANGE
RANGE SLIDER
[0, 1]
fitMode: "none" | "cover" | "contain"
Fit Mode
ENUM
DROPDOWN
"none"
leftBoundAngle: int
leftBoundAngle
INT
TEXT INPUT
0
rightBoundAngle: int
rightBoundAngle
INT
TEXT INPUT
0
topBoundAngle: int
topBoundAngle
INT
TEXT INPUT
0
bottomBoundAngle: int
bottomBoundAngle
INT
TEXT INPUT
0
showBoundsOutline: boolean
Show Outline
BOOL
TOGGLE
false
boundsOutlineStyle: "dashed" | "solid" | "dotted"
Line Style
ENUM
DROPDOWN
"dashed"
boundsOutlineThickness: float
Line Thickness
FLOAT
RANGE SLIDER
1
boundsOutlineColor: IColor
Line Color
COLOR
COLOR PICKER
[1, 1, 1, 1]
uvOffsetX: float
UV Offset X
FLOAT
RANGE SLIDER
0
uvOffsetY: float
UV Offset Y
FLOAT
RANGE SLIDER
0
uvScaleX: float
UV Scale X
FLOAT
RANGE SLIDER
1
uvScaleY: float
UV Scale Y
FLOAT
RANGE SLIDER
1
depth: float
Depth
FLOAT
RANGE SLIDER
-0.5
color: IColor
Color
COLOR
COLOR PICKER
[1, 1, 1, 1]
colorMix: float
Color Mix
FLOAT
RANGE SLIDER
0.5
emissiveIntensity: float
Emissive
FLOAT
RANGE SLIDER
0
emissiveMap: IMediaItem
Emissive Map
MEDIA_ITEM
ELEMENT SELECTOR
""
emissiveColor: IColor
emissiveColor
COLOR
COLOR PICKER
[1, 1, 1, 1]

Material Effect and Surface Texture Mapping#

Effect<MaterialEffect>: A versatile material shader that maps custom color, normal, and displacement textures onto 3D assets with full tiling and offset controls.

The Imported Material effect is the standard shader used to project high-fidelity textures onto 3D objects in Aircada.

It supports assigning a primary texture via the materialMediaItemId property, managing compression settings with the defaultImageQuality enum, and layering tint values through overlayColor and overlayColorMap. For advanced surface detail, it utilizes normalScale and displacementScale alongside their corresponding image maps. The positioning and tiling of these assets are customized using the collapsible Scale & Position section, containing uvScaleX, uvScaleY, uvOffsetX, and uvOffsetY scaling properties.

Material

XR_MATERIAL.AME_IMPORTED_MATERIAL
Effect
Effect System ID
AME_IMPORTED_MATERIAL
Pipeline Type
XR_MATERIAL
Context Type
XR_UNIT

Material Properties Details

Property & TypeDisplay NameSystem TypeDefault
materialMediaItemId: IMediaItem
Material
MEDIA_ITEM
ELEMENT SELECTOR
""
defaultImageQuality: "ORIGINAL" | "TINY" | "LOW" | "MEDIUM" | "HIGH" | "OPTIMIZED" | "KTX2_TINY" | "KTX2_LOW" | "KTX2_MEDIUM" | "KTX2_HIGH"
Quality
ENUM
OPTION SELECTOR
"KTX2_MEDIUM"
overlayColor: IColor
Color
COLOR
COLOR PICKER
[1, 1, 1, 1]
overlayColorMap: IMediaItem
overlayColorMap
MEDIA_ITEM
ELEMENT SELECTOR
""
normalScale: float
Normal
FLOAT
RANGE SLIDER
1
normalScaleMap: IMediaItem
normalScaleMap
MEDIA_ITEM
ELEMENT SELECTOR
""
displacementScale: float
Displacement
FLOAT
RANGE SLIDER
0
displacementScaleMap: IMediaItem
displacementScaleMap
MEDIA_ITEM
ELEMENT SELECTOR
""
uvScaleX: float
Scale X
FLOAT
RANGE SLIDER
4
uvScaleY: float
Scale Y
FLOAT
RANGE SLIDER
4
uvOffsetX: float
Offset X
FLOAT
RANGE SLIDER
0
uvOffsetY: float
Offset Y
FLOAT
RANGE SLIDER
0

Real-Time Reflector and Mirror Material Effect#

Effect<ReflectorEffect>: A real-time reflection material shader that turns 3D surfaces into dynamic mirrors with depth masking and normal-map distortion.

The Reflector effect turns static surfaces into interactive mirrors that reflect surrounding environment objects in real-time.

The resolution of the reflection is controlled by resolutionScale, and multiobject bounces can be toggled using bounces. The reflection can be refined using depth-based effects like useDepthMask, useDepthTransparency, and depthFactor. Moving liquid or wavy glass appearances can also be simulated by applying a normal or flow map to distortionTextureMediaItemId and adjusting the intensity and tiling via distortionScale and distortionTiling.

Reflector

XR_MATERIAL.AME_REFLECTOR
Effect
Effect System ID
AME_REFLECTOR
Pipeline Type
XR_MATERIAL
Context Type
XR_UNIT

Reflector Properties Details

Property & TypeDisplay NameSystem TypeDefault
resolutionScale: float
Resolution Scale
FLOAT
RANGE SLIDER
1
useDepthMask: boolean
Depth Mask
BOOL
TOGGLE
false
useDepthTransparency: boolean
Depth Transparency
BOOL
TOGGLE
false
depthFactor: float
Depth Factor
FLOAT
RANGE SLIDER
1
bounces: boolean
Reflects Others
BOOL
TOGGLE
false
distortionTextureMediaItemId: IMediaItem
Normal/Flow Texture
MEDIA_ITEM
ELEMENT SELECTOR
""
distortionScale: float
Distortion Scale
FLOAT
RANGE SLIDER
0.01
distortionTiling: float
Distortion Tiling
FLOAT
RANGE SLIDER
5

3D Sticker Decal Projection Material Effect#

Effect<StickerEffect>: A material shader that projects a customizable image decal onto a 3D model with interactive positioning, boundaries, scaling, and rotation.

The Sticker effect is the main way to put a custom image or decal on any 3D model in Aircada.

It applies a primary graphic to a surface using the textureMediaItemId property, with an option to tint or blend colors through colorBlend and soften edges using feather. Positioning and scaling of the decal are managed interactively via proportionalScalar (Scale), textureOffsetX (Center X), textureOffsetY (Center Y), and uvRotation (Rotation). For complex models, the sticker's boundaries can be restricted using useBoundaries alongside precise bounds controls like xBoundaries, yBoundaries, and orientation angles (leftBoundAngle, rightBoundAngle, topBoundAngle, bottomBoundAngle).

Sticker

XR_MATERIAL.ASE_TEXTURE_STICKER_MATERIALFX
Effect
Effect System ID
ASE_TEXTURE_STICKER_MATERIALFX
Pipeline Type
XR_MATERIAL
Context Type
XR_UNIT

Sticker Properties Details

Property & TypeDisplay NameSystem TypeDefault
textureMediaItemId: IMediaItem
Material
MEDIA_ITEM
ELEMENT SELECTOR
""
colorBlend: IColor
Color Blend
COLOR
COLOR PICKER
[1, 1, 1, 1]
replaceColor: boolean
Replace Color
BOOL
TOGGLE
false
feather: float
Feather
FLOAT
RANGE SLIDER
0.1
proportionalScalar: float
Scale
FLOAT
RANGE SLIDER
0.5
textureOffsetX: float
Center X
FLOAT
RANGE SLIDER
0.5
textureOffsetY: float
Center Y
FLOAT
RANGE SLIDER
0.5
uvRotation: float
Rotation
FLOAT
RANGE SLIDER
0
uvCorrectionAngle: float
Angle Correction
FLOAT
RANGE SLIDER
0
manualUVScaleX: float
UV Adjust X
FLOAT
RANGE SLIDER
1
manualUVScaleY: float
UV Adjust Y
FLOAT
RANGE SLIDER
1
useBoundaries: boolean
Use Bounds
BOOL
TOGGLE
false
xBoundaries: [number, number]
X Bounds
RANGE
RANGE SLIDER
[0, 1]
yBoundaries: [number, number]
Y Bounds
RANGE
RANGE SLIDER
[0, 1]
fitMode: "none" | "cover" | "contain"
Fit Mode
ENUM
DROPDOWN
"none"
leftBoundAngle: int
leftBoundAngle
INT
TEXT INPUT
0
rightBoundAngle: int
rightBoundAngle
INT
TEXT INPUT
0
topBoundAngle: int
topBoundAngle
INT
TEXT INPUT
0
bottomBoundAngle: int
bottomBoundAngle
INT
TEXT INPUT
0
showBoundsOutline: boolean
Show Outline
BOOL
TOGGLE
false
boundsOutlineStyle: "dashed" | "solid" | "dotted"
Line Style
ENUM
DROPDOWN
"dashed"
boundsOutlineThickness: float
Line Thickness
FLOAT
RANGE SLIDER
1
boundsOutlineColor: IColor
Line Color
COLOR
COLOR PICKER
[1, 1, 1, 1]
uvOffsetX: float
UV Offset X
FLOAT
RANGE SLIDER
0
uvOffsetY: float
UV Offset Y
FLOAT
RANGE SLIDER
0
uvScaleX: float
UV Scale X
FLOAT
RANGE SLIDER
1
uvScaleY: float
UV Scale Y
FLOAT
RANGE SLIDER
1