Skip to main content

Interactions

Interactions are predefined functions defined in the backend (Unity).
These functions can be used to make changes to a product or its visualization.

Creating Interactions​

A new Interaction can be created by clicking the “Create” button within the CRUD component.
Existing Interactions can be edited or viewed via the inline icons.

An Interaction is used to call/execute backend functions (Unity).
→ Example: Changing the material color of a 3D object

Fields​

  • Code (mandatory)
    → Technical name of the Interaction

    • Freely selectable
    • Should follow the general naming convention
    • Must be unique within Interactions

  • ActionName (mandatory)
    → Definition of an Action

    • Actions are functions in the backend that can be used in various areas of 3D-Customizing
    • Example: "ChangeColor"

  • Descriptions (optional)
    → Description of the Interaction in multiple languages

    • de_de = Farbe wechseln
    • en_en = Change Color
    • …

Workflow​

  1. Click “Create” → Dialog for entering a new Interaction opens
  2. Define Code
  3. Assign ActionName
  4. Optionally enter Description
  5. Save → Create the new Interaction
  6. Save → Save changes (when editing)

Interaction-Parameters

InteractionParameters can be used to pass additional parameters to backend functions (Unity).
→ Example: Name of a predefined texture that should always be assigned during execution.

IMPORTANT​

  • InteractionParameters defined directly on an Interaction are globally valid → they are set on every call of the Interaction.
  • Context-related InteractionParameters (e.g. CharacteristicInteractionParameter) are context-related and are only set if the Interaction is executed in relation to a specific Characteristic.

Fields​

  • Code (mandatory)
    → Technical name of the InteractionParameter

    • Freely selectable
    • Should follow the general naming convention
    • Must be unique within InteractionParameters

  • Type (mandatory)
    → Type of parameter:

    • Choice
      → Indicates which Choice the Interaction refers to

    • GameObjectName
      → Optional parameter specifying the path of the child element the Interaction should be applied to

    • CodeParameterPair
      → Key-value pair used to pass required parameters into the script
      (see the Interactions documentation for more information)

  • Parameter (mandatory)
    → Value passed to the corresponding backend function

    • Example: "Logo"

  • Description (optional)
    → Description of the InteractionParameter in multiple languages

    • de_de = Reference 01
    • en_en = Reference 01
    • …

Workflow​

  1. Click “Create” → Dialog for entering a new InteractionParameter opens
  2. Define Type
  3. Assign Parameter
  4. Optionally enter Description
  5. Save → Create the new InteractionParameter
  6. Save → Save changes

Note​

An Interaction can have any number (n) of InteractionParameters assigned.