Skip to main content

Enumeration: OptionSetMode

Defines the selection mode for option blocks.

OptionSetMode determines how options are sourced and how users interact with the block. Different modes enable different user experiences and capabilities.

The mode chosen affects both the data structure of the block and how it behaves in the configurator interface. It's a fundamental property that determines what kind of customization the block enables.

Enumeration Members​

COLOR​

COLOR: "COLOR"

Provides a color picker interface for selecting custom colors.

This mode enables advanced color selection beyond predefined swatches. Users can select precise colors from a color picker, input hex values, or choose from expanded palettes.

The COLOR mode is particularly useful for products with custom paint options, digital prints, or any application where exact color matching is important. It supports color presets, recently used colors, and can be configured to limit selection to specific color ranges.

ENGRAVE​

ENGRAVE: "ENGRAVE"

Allows user to create engraving and embossing textures for 3D models.

This specialized mode enables text customization features. Users can input text that gets rendered onto the 3D model as either raised (embossed) or recessed (engraved) features. Commonly used for personalization, such as adding names to jewelry or custom text to plaques.

IMAGE​

IMAGE: "IMAGE"

Allows user to upload their own images which can be used as logo, texture etc.

This mode enables full image customization, letting users upload their own images to be applied to the product. Common applications include custom printing on products, logo application, or texture replacement. The system handles image processing, scaling, and texture mapping automatically.

INPUT​

INPUT: "INPUT"

Provides text or numerical input fields for user data entry.

This mode enables direct text or number input through form fields. It's used for collecting specific information like measurements, quantities, or custom text that doesn't require visual rendering on the 3D model (unlike ENGRAVE mode).

Common applications include collecting dimensions for custom sizing, special instructions, or configuration parameters that affect pricing or manufacturing without visual changes.

LINKED​

LINKED: "LINKED"

Most common mode. Block will be using one of existing Material Collections or Option Sets.

This mode allows for reuse of centrally defined option sets across multiple products. For example, a standard set of fabric options can be defined once and linked to multiple furniture products. Changes to the source option set are reflected in all products using it.

MANUAL​

MANUAL: "MANUAL"

Similarly to LINKED mode it uses option sets but in this case these are created locally per this specific block only.

This mode is used when options are specific to a single product and don't need to be reused. For example, a custom size option that only applies to one particular product model would use MANUAL mode.

MESSAGE​

MESSAGE: "MESSAGE"

Displays informational content without option selection capabilities.

This mode is used to show important notes, instructions, warnings, or other information to users during the configuration process. It doesn't collect any user input and doesn't affect the product configuration.

Message blocks can be conditionally displayed based on other option selections, making them useful for guiding users through complex configuration processes or explaining compatibility considerations.

PRINT_ON_DEMAND: "PRINT_ON_DEMAND"

Enables print-on-demand customization with advanced image placement capabilities.

This mode provides an advanced image customization experience optimized for print-on-demand applications. Users can upload, position, scale, and rotate images on predefined product print areas. The system manages resolution requirements, color adjustments, and preview generation to ensure print quality.

Commonly used for custom apparel, promotional items, and personalized products where precise image placement is important.