Scene properties (USTR)¶

Every scene property has a unique string identifier, its USTR. USTRs are what you pass to the command line set and set_string commands and to the viewer messaging API set_string / get_string messages.

How it works¶

A set_string call takes two parts: the node picks what you are editing (::globals, ::camera, a layer name, or an id), and the USTR names the property on it. The set succeeds when the name is valid and the target actually has that property.

Note

The command line set <ustr> <value> shorthand derives the node from the prefix, so it only reaches globals_, animation_, camera_, and render_pipeline_ properties. Use set_string to reach per-object obj_* properties.

Value encoding¶

All values travel as strings and are parsed according to the property's type:

Type	Format	Example
bool	`0` or `1`	`1`
int	decimal integer	`1920`
float	decimal number	`45.0`
color	`r,g,b` in 0.0 to 1.0	`0.8,0.2,0.1`
enum	index as string	`2`
string	UTF-8 text	`My Scene`
void	button property; setting any value triggers it	`1`

Availability¶

Label	Meaning
standard	Exposed in the editor UI. Safe, supported surface.
pro	Standard, but tied to a PRO feature (branding, spinner, interactive export).
virtual	Reads and writes the live on-screen camera directly.

Globals (`::globals`)¶

USTR	Type		Description
`globals_resolution_preset`	enum	standard	Resolution preset (0 = custom).
`globals_resolution_w`	int	standard	Render width in pixels.
`globals_resolution_h`	int	standard	Render height in pixels.
`globals_ground_scale`	float	standard	Ground plane scale.
`globals_ground_angle`	float	standard	Ground plane rotation, degrees.
`globals_ibl_angle`	float	standard	Environment rotation, degrees.
`globals_ibl_shadows_gamma`	float	standard	Shadow gamma correction.
`globals_floor_mirror_enable`	bool	standard	Enable floor mirror reflection.
`globals_floor_mirror_weight`	float	standard	Mirror reflection weight.
`globals_floor_gi_see_through`	color	standard	Floor see-through color.
`globals_backplate_color`	color	standard	Background color.
`globals_pose_yaw`	float	standard	Model yaw rotation, degrees.
`globals_pose_pos_z`	float	standard	Model vertical offset.
`globals_viewer_title`	string	standard	Viewer title string.
`globals_viewer_nocontrols`	bool	standard	Hide viewer controls.
`globals_viewer_nolabels`	bool	standard	Hide material group labels.
`globals_viewer_autospin`	bool	standard	Viewer starts with auto-spin enabled.
`globals_atlas_layout`	enum	standard	Atlas contact sheet layout.
`globals_atlas_slot_0_viewpoint_id` ... `globals_atlas_slot_4_viewpoint_id`	int	standard	Saved viewpoint assigned to each atlas slot.
`globals_branding_frontplate_enable`	bool	pro	Enable the branding frontplate overlay.
`globals_branding_frontplate_alignment`	enum	pro	Frontplate corner or edge alignment.
`globals_branding_frontplate_margin`	float	pro	Frontplate margin.
`globals_branding_frontplate_scale`	float	pro	Frontplate scale.
`globals_branding_frontplate_color_map`	string	pro	Frontplate image.
`globals_branding_intro_enable`	bool	pro	Enable the intro branding sequence.
`globals_branding_intro_color`	color	pro	Intro veil color.
`globals_branding_intro_color_map`	string	pro	Intro logo image.
`globals_branding_intro_scale`	float	pro	Intro logo scale.
`globals_branding_intro_veil_hold`	float	pro	Intro veil hold time.
`globals_branding_intro_logo_hold`	float	pro	Intro logo hold time.
`globals_branding_outro_*`	mixed	pro	Outro counterparts of the intro set above.

Camera (`::camera`)¶

USTR	Type		Description
`camera_hfov`	float	standard	Horizontal field of view, degrees.
`camera_dof_enable`	bool	standard	Enable depth of field.
`camera_focus`	float	standard	Focus distance, millimeters.
`camera_dof_max_radius`	float	standard	Maximum blur radius.
`camera_center_view`	void	standard	Button: recenter the view on the model.
`camera_pick_focus`	void	standard	Button: pick the focus distance interactively.

Live camera (virtual)¶

These names are handled specially on ::camera: they read and write the live on-screen camera, so they always reflect what is on screen. Angles are in degrees.

USTR	Type		Description
`tracker_cam_theta`	float	virtual	Orbit azimuth, degrees.
`tracker_cam_phi`	float	virtual	Orbit elevation, degrees.
`tracker_cam_dolly`	float	virtual	Camera distance.
`tracker_cam_pan_x` / `tracker_cam_pan_y`	float	virtual	Screen space pan.
`tracker_cam_hfov`	float	virtual	Live horizontal field of view, degrees.

Render pipeline (`::render_pipeline`)¶

USTR	Type		Description
`render_pipeline_glare_enable`	bool	standard	Enable glare.
`render_pipeline_glare_strength`	float	standard	Glare intensity.
`render_pipeline_ssr_re_enable`	bool	standard	Enable round edges.
`render_pipeline_ssr_re_radius`	float	standard	Round edges radius.
`render_pipeline_sharpen_enable`	bool	standard	Enable sharpening.
`render_pipeline_sharpen_strength`	float	standard	Sharpen intensity.

Animation (`::animation`)¶

USTR	Type		Description
`animation_bitrate`	int	standard	Video bitrate.
`animation_speed`	float	standard	Animation speed.
`animation_easing`	enum	standard	Easing function.
`animation_rotate`	float	standard	Rotation amount.
`animation_rotate_flip`	bool	standard	Flip rotation direction.
`animation_boomerang_enable`	bool	standard	Boomerang (ping-pong) playback.
`animation_motion_blur_enable`	bool	standard	Motion blur.

Objects and materials (per layer)¶

Object properties live on layers. Address them with the layer name or its id: set_string "Metal Band" obj_visible 0.

USTR	Type		Description
`obj_visible`	bool	standard	Layer visibility.

The most useful material controls per family:

USTR	Type	Family	Description
`obj_mtl_absorption`	float	gemstone	Light absorption (color depth).
`obj_mtl_scs_amplitude`	float	gemstone	Clarity.
`obj_mtl_roughness`	float	metal, pearl	Surface roughness.
`obj_mtl_coating_weight`	float	pearl, plastic	Luster (pearl) or glossiness (plastic).
`obj_mtl_coating_roughness`	float	opal, plastic	Coating roughness.