ParaShape

Placement and instance properties

Entries of an object's properties: placement scalars, paint, identity, visibility and click actions of one instance.

24 methods: name, material, layer, translateX, translateY, translateZ, rotateX, rotateY, rotateZ, scaleX, scaleY, scaleZ, pivotX, pivotY, pivotZ, copies, background, shading, exposure, shadows, axes, visible, onClick, attributes.

name - Name

Placement name (BaseInstance.name).

role step, type placement, valid on properties, returns string, default key name.

ArgTypeDefaultMinMaxOptionsDescription
valuestring | function''Text, or an arrow (i) => text per copy; empty string means unnamed.

material - Material

materials[] record key per placement.

role step, type placement, valid on curve, mesh, block, returns string, default key material.

ArgTypeDefaultMinMaxOptionsDescription
valuematerial | function''Quoted materials[] key (e.g. "'oak'"), or an arrow (i) => key per copy; absent inherits the content's own material.

layer - Layer

layers[] record key per placement.

role step, type placement, valid on properties, returns string, default key layer.

ArgTypeDefaultMinMaxOptionsDescription
valuelayer | function''Quoted layers[] key, or an arrow (i) => key per copy; absent inherits the content's own layer.

translateX - Translate X

M = T(t)*T(p)*Rz*Ry*Rx*S*T(-p).

role step, type placement, valid on properties, returns number, default key translateX.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber | function0Offset along X in mm, or an arrow (i) => number per copy (i = copy index); applied last, outside the pivot.

translateY - Translate Y

M = T(t)*T(p)*Rz*Ry*Rx*S*T(-p).

role step, type placement, valid on properties, returns number, default key translateY.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber | function0Offset along Y in mm, or an arrow (i) => number per copy (i = copy index); applied last, outside the pivot.

translateZ - Translate Z

M = T(t)*T(p)*Rz*Ry*Rx*S*T(-p).

role step, type placement, valid on properties, returns number, default key translateZ.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber | function0Offset along Z in mm, or an arrow (i) => number per copy (i = copy index); applied last, outside the pivot.

rotateX - Rotate X

M = T(t)*T(p)*Rz*Ry*Rx*S*T(-p).

role step, type placement, valid on properties, returns number, default key rotateX.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber | function0Degrees about X through the pivot (applied Rz*Ry*Rx), or an arrow (i) => number per copy.

rotateY - Rotate Y

M = T(t)*T(p)*Rz*Ry*Rx*S*T(-p).

role step, type placement, valid on properties, returns number, default key rotateY.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber | function0Degrees about Y through the pivot (applied Rz*Ry*Rx), or an arrow (i) => number per copy.

rotateZ - Rotate Z

M = T(t)*T(p)*Rz*Ry*Rx*S*T(-p).

role step, type placement, valid on properties, returns number, default key rotateZ.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber | function0Degrees about Z through the pivot (applied Rz*Ry*Rx), or an arrow (i) => number per copy.

scaleX - Scale X

M = T(t)*T(p)*Rz*Ry*Rx*S*T(-p) — the object own placement, not the chain scale step.

role step, type placement, valid on properties, returns number, default key scaleX.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber | function1Factor along X about the pivot, or an arrow (i) => number per copy.

scaleY - Scale Y

M = T(t)*T(p)*Rz*Ry*Rx*S*T(-p) — the object own placement, not the chain scale step.

role step, type placement, valid on properties, returns number, default key scaleY.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber | function1Factor along Y about the pivot, or an arrow (i) => number per copy.

scaleZ - Scale Z

M = T(t)*T(p)*Rz*Ry*Rx*S*T(-p) — the object own placement, not the chain scale step.

role step, type placement, valid on properties, returns number, default key scaleZ.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber | function1Factor along Z about the pivot, or an arrow (i) => number per copy.

pivotX - Pivot X

The placement own turning point, X axis.

role step, type placement, valid on properties, returns number, default key pivotX.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber | functionX of the turning point in mm, or an arrow (i) => number per copy. Absent = the content bbox min on this axis, except a chain-produced block (placeComponent/clone), which pivots at its own origin.

pivotY - Pivot Y

The placement own turning point, Y axis.

role step, type placement, valid on properties, returns number, default key pivotY.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber | functionY of the turning point in mm, or an arrow (i) => number per copy. Absent = the content bbox min on this axis, except a chain-produced block (placeComponent/clone), which pivots at its own origin.

pivotZ - Pivot Z

The placement own turning point, Z axis.

role step, type placement, valid on properties, returns number, default key pivotZ.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber | functionZ of the turning point in mm, or an arrow (i) => number per copy. Absent = the content bbox min on this axis, except a chain-produced block (placeComponent/clone), which pivots at its own origin.

copies - Copies

Copies ADDED — absent or 0 is one placement.

role step, type placement, valid on properties, returns integer, default key copies.

ArgTypeDefaultMinMaxOptionsDescription
valueinteger00Non-negative count of copies ADDED beyond the first; 0 or absent places exactly once. Beside a placeComponent whose parameters is an arrow, every copy is its own parameter set.

background - Background

A view's clear color.

role step, type placement, valid on views, returns color, default key background.

ArgTypeDefaultMinMaxOptionsDescription
valuecolorViewport clear color. Absent = the host's own background.

shading - Shading

A view's display mode.

role step, type placement, valid on views, returns string, default key shading.

ArgTypeDefaultMinMaxOptionsDescription
valuestring['wireframe', 'shaded', 'realistic', 'xray']'shaded' is the self-lit matcap editing look (default); 'realistic' is the only mode materializing lights and the environment; 'wireframe' is the line overlay; 'xray' is the shaded look with see-through faces.

exposure - Exposure

A view's metered-exposure multiplier; realistic shading only.

role step, type placement, valid on views, returns number, default key exposure.

ArgTypeDefaultMinMaxOptionsDescription
valuenumber0Linear multiplier on metered auto-exposure. Shading 'realistic' only; absent = 1.

shadows - Shadows

Analytic sun-study overlay for this view; absent = off.

role step, type placement, valid on views, returns boolean, default key shadows.

ArgTypeDefaultMinMaxOptionsDescription
valuebooleanAnalytic sun-study overlay for this view; absent = off.

axes - Axes

World-axes visibility for this view; absent = host default (on).

role step, type placement, valid on views, returns boolean, default key axes.

ArgTypeDefaultMinMaxOptionsDescription
valuebooleanWorld-axes visibility for this view; absent = host default (on).

visible - Visible

true/false, a non-empty list of view keys, or an arrow (i, camera) => boolean.

role step, type placement, valid on properties, layers, returns boolean, default key visible.

ArgTypeDefaultMinMaxOptionsDescription
valueobject | functiontruetrue/false, a non-empty array of view keys, or an arrow (i, camera) => boolean (i = the copy index) — shown for every camera the function returns true for, the free camera included (see the view type for the record it receives); absent inherits the content's own visibility. camera is readable only here.

onClick - On click

What a click on this object does; the host plays it, the engine never does.

role step, type placement, valid on properties, returns action, default key onClick.

ArgTypeDefaultMinMaxOptionsDescription
valueaction | functionAn action Property.animate(name, seconds, [v1, ...]) or Property.set(name, [v1, ...]), an array of them, or an arrow (i) => action per copy. name is one of this object own instance properties (translateX..pivotZ, material, layer, visible); successive clicks walk the values in order and wrap. Absent = not clickable.

attributes - Attributes

Free-form domain bag.

role step, type placement, valid on properties, materials, layers, patterns, returns object, default key attributes.

ArgTypeDefaultMinMaxOptionsDescription
valueobject | function{}Free-form JSON object merged onto this placement's attributes; the engine reads nothing out of it.

Edit on GitHub