Class Eval

Collection of utility functions and data, for the implementation of Evaluators.

Hierarchy

  • Eval

Constructors

constructor

Properties

AUTO_INHERIT DERIVED EVALUATOR_PARAMETERS INTERACTOR_PARAMETERS MAPPINGS MAPPINGS_DESCRIPTION MAPPINGS_Name MAPPINGS_ROTATION MAPPINGS_SCALE_S MAPPINGS_SCALE_T MAPPINGS_TRANSLATION_S MAPPINGS_TRANSLATION_T NO_GEOMETRY PRODUCTS PRODUCTS_EVALUATOR PRODUCTS_GEOMETRY PRODUCTS_GEOMETRY_PARAMETERS PRODUCTS_INTERACTOR PRODUCTS_LAYER PRODUCTS_MAPPING PRODUCTS_MATERIAL PRODUCTS_PATH PRODUCTS_POSITION PRODUCTS_PRODUCT PRODUCTS_ROTATION PRODUCTS_SCALE PRODUCTS_SELECTABLE PRODUCTS_VISIBLE SCRIPT_KEY SCRIPT_PATH SCRIPT_PRODUCT SCRIPT_VALUE SELECTABLE_NONE SELECTABLE_PARENT SELECTABLE_SELF

Methods

CallEvaluator GetBoolean GetEvaluator GetFloat GetInteger GetPath GetString GetStrings GetSymbol IsEvaluator ScopeIfUnscoped

Constructors

constructor

Properties

Static Readonly AUTO_INHERIT

AUTO_INHERIT: "_AutoInherit" = "_AutoInherit"

Pre-defined identifier for the special evaluator parameter that forces the inheritance of evaluator parameters to the immediate children that also have an evaluator assigned.

Static Readonly DERIVED

DERIVED: "Derived" = "Derived"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit EvalResponse member instead.

Static Readonly EVALUATOR_PARAMETERS

EVALUATOR_PARAMETERS: "EvaluatorParameters" = "EvaluatorParameters"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit EvalResponse member instead.

Static Readonly INTERACTOR_PARAMETERS

INTERACTOR_PARAMETERS: "InteractorParameters" = "InteractorParameters"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit EvalResponse member instead.

Static Readonly MAPPINGS

MAPPINGS: "Mappings" = "Mappings"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit EvalResponse member instead.

Static Readonly MAPPINGS_DESCRIPTION

MAPPINGS_DESCRIPTION: "Description" = "Description"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Mapping member instead.

Static Readonly MAPPINGS_Name

MAPPINGS_Name: "Name" = "Name"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Mapping member instead.

Static Readonly MAPPINGS_ROTATION

MAPPINGS_ROTATION: "Rotation" = "Rotation"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Mapping member instead.

Static Readonly MAPPINGS_SCALE_S

MAPPINGS_SCALE_S: "ScaleS" = "ScaleS"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Mapping member instead.

Static Readonly MAPPINGS_SCALE_T

MAPPINGS_SCALE_T: "ScaleT" = "ScaleT"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Mapping member instead.

Static Readonly MAPPINGS_TRANSLATION_S

MAPPINGS_TRANSLATION_S: "TranslationS" = "TranslationS"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Mapping member instead.

Static Readonly MAPPINGS_TRANSLATION_T

MAPPINGS_TRANSLATION_T: "TranslationT" = "TranslationT"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Mapping member instead.

Static Readonly NO_GEOMETRY

NO_GEOMETRY: "_None" = "_None"

Pre-defined identifier for corresponding Evaluator parameter.

Deprecated

Use None instead.

Static Readonly PRODUCTS

PRODUCTS: "Products" = "Products"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit EvalResponse member instead.

Static Readonly PRODUCTS_EVALUATOR

PRODUCTS_EVALUATOR: "Evaluator" = "Evaluator"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly PRODUCTS_GEOMETRY

PRODUCTS_GEOMETRY: "Geometry" = "Geometry"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly PRODUCTS_GEOMETRY_PARAMETERS

PRODUCTS_GEOMETRY_PARAMETERS: "GeometryParameters" = "GeometryParameters"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly PRODUCTS_INTERACTOR

PRODUCTS_INTERACTOR: "Interactor" = "Interactor"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly PRODUCTS_LAYER

PRODUCTS_LAYER: "Layer" = "Layer"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly PRODUCTS_MAPPING

PRODUCTS_MAPPING: "Mapping" = "Mapping"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly PRODUCTS_MATERIAL

PRODUCTS_MATERIAL: "Material" = "Material"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly PRODUCTS_PATH

PRODUCTS_PATH: "Path" = "Path"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly PRODUCTS_POSITION

PRODUCTS_POSITION: "Position" = "Position"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly PRODUCTS_PRODUCT

PRODUCTS_PRODUCT: "Product" = "Product"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly PRODUCTS_ROTATION

PRODUCTS_ROTATION: "Rotation" = "Rotation"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly PRODUCTS_SCALE

PRODUCTS_SCALE: "Scale" = "Scale"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly PRODUCTS_SELECTABLE

PRODUCTS_SELECTABLE: "Selectable" = "Selectable"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly PRODUCTS_VISIBLE

PRODUCTS_VISIBLE: "Visible" = "Visible"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit Product member instead.

Static Readonly SCRIPT_KEY

SCRIPT_KEY: "Key" = "Key"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit ScriptParameter member instead.

Static Readonly SCRIPT_PATH

SCRIPT_PATH: "Path" = "Path"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit ScriptParameter member instead.

Static Readonly SCRIPT_PRODUCT

SCRIPT_PRODUCT: "Product" = "Product"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit ScriptParameter member instead.

Static Readonly SCRIPT_VALUE

SCRIPT_VALUE: "Value" = "Value"

Pre-defined identifier for Eval responses.

Deprecated

Use explicit ScriptParameter member instead.

Static Readonly SELECTABLE_NONE

SELECTABLE_NONE: Selectable

Pre-defined identifier for Eval responses.

Deprecated

Use type Selectable instead.

Static Readonly SELECTABLE_PARENT

SELECTABLE_PARENT: Selectable

Pre-defined identifier for Eval responses.

Deprecated

Use type Selectable instead.

Static Readonly SELECTABLE_SELF

SELECTABLE_SELF: Selectable

Pre-defined identifier for Eval responses.

Deprecated

Use type Selectable instead.

Methods

Static CallEvaluator

  • Call an Evaluator script and merges the response with the passed response.

    Returns

    The enhanced response.

    Parameters

    • response: EvalResponse

      The current response passed from the calling context, or undefined.

    • evaluator: string

      The fully scoped Evaluator class name.

    • productId: string
    • path: string

      The component path for which the Evaluator will be called, null is passed for the root.

    • parameters: {
          [key: string]: any;
      }

      Evaluator parameters.

      • [key: string]: any

    Returns EvalResponse

Static GetBoolean

  • Gets a boolean from a parameter.

    Returns

    The value to be applied.

    Parameters

    • value: any

      The value to get from.

    • Optional defaultValue: boolean

      The default value to be designed if there's no (valid) value.

    Returns boolean

Static GetEvaluator

  • Gets an Evaluator object, even if only a string is passed.

    Returns

    An Evaluator object.

    Parameters

    • evaluator: string | object

      Either an Evaluator class name, or an object.

    Returns object

Static GetFloat

  • Gets a float number from a parameter.

    Returns

    The value to be applied.

    Parameters

    • value: any

      The value to get from.

    • Optional defaultValue: number

      The default value to be designed if there's no (valid) value.

    Returns number

Static GetInteger

  • Gets an integer number from a parameter.

    Returns

    The value to be applied.

    Parameters

    • value: any

      The value to get from.

    • Optional defaultValue: number

      The default value to be designed if there's no (valid) value.

    Returns number

Static GetPath

  • Creates the path prefix for the new product/component.

    Returns

    The complete path for the new product/component.

    Parameters

    • parent: string

      The parent path or null.

    • number: number

      The object's number, starting at 0.

    Returns string

Static GetString

  • Gets a string from a parameter.

    Returns

    The value to be applied.

    Parameters

    • value: any

      The value to get from.

    • Optional defaultValue: string

      The default value to be designed if there's no (valid) value.

    Returns string

Static GetStrings

  • Gets a string list from a parameter, strings should be separated by space.

    Returns

    The value to be applied.

    Parameters

    • value: string

      The value to get from.

    • Optional minSize: number

      The required minimum size. If needed, the last entry will be inserted again until the required size is reached.

    • Optional defaultValue: string[]

      The default value to be designed if there's no (valid) value.

    Returns string[]

Static GetSymbol

  • Gets a string (out of a list of fix strings) from a parameter.

    Returns

    The value to be applied.

    Parameters

    • value: any

      The value to get from.

    • values: string[]

      The available values, the first one is the default.

    Returns string

Static IsEvaluator

  • Checks if the passed name is an evaluator. This may be used for polymorphic geometry parameters that may be Evaluators or Geometries.

    Returns

    true if there is a corresponding evaluator type.

    Parameters

    • evaluator: string

      A potential evaluator type.

    Returns boolean

Static ScopeIfUnscoped

  • Adds scope to the name if it is not already scoped.

    Handles implicit material categories (e.g. "@Wood_Birch")

    Static

    Returns

    {string}

    Parameters

    • name: string
    • scope: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc