Class EvalResponse

Evaluator response. The response may return components to be merged into the overall component hierarchy of the product. If so, a few rules must be applied:

  • The component array must describe a consistent top-down hierarchy, and must contain a parent prior to it's children. To avoid name collisions with database components, which are named oX, components created by an evaluator must be named eX. Please use IGX.Eval.GetPath() to create the name.
  • The first component in the component array should be the root component it self and it's name should be null/undefined to mark this special role. The calling context may already have a corresponding component and thus should merge the non-spatial atributes then (Geometry, Material Category, etc.). Do not specify spatial attributes for the root component as they would be ignored anyway! The spatial attributes if the tree created by the Evaluator, will be set by the calling context.

Hierarchy

  • EvalResponse

Constructors

constructor

Properties

AttachPoints? AutoInherit? Derived? EvaluatorParameters? GeometryParameters? InteractorParameters? Products?

Methods

addEvaluatorParameter addGeometryParameter addInteractorParameter finalize

Constructors

constructor

Properties

Optional AttachPoints

AttachPoints?: AttachPoint[]

Array of Attachment points.

Optional AutoInherit

AutoInherit?: boolean

Enables auto-inheritance of the (evaluator) parameters passed to the evaluator itself, to the immediate children that also have an evaluator assigned. The result is the same as setting _AutoInherit to true as part of the parameters. Note. If auto inheritance is already enabled by _AutoInherit it will stay enabled - even if the evaluator returns false.

Optional Derived

Derived?: {
    [parameter: string]: any;
}

Array of derived Evaluator Parameters. These parameters are created by a super class Create() call and then used by the calling evaluator.

Type declaration

  • [parameter: string]: any

Optional EvaluatorParameters

EvaluatorParameters?: ScriptParameter[]

Array of Evaluator Parameters, for the created components.
Note. Evaluator parameters can not be assigned to the root node itself.

Optional GeometryParameters

GeometryParameters?: ScriptParameter[]

Array of Geometry Parameters, for the created components.

Optional InteractorParameters

InteractorParameters?: ScriptParameter[]

Array of Interactor Parameters, for the created components.
Note. Interactor parameters can not be assigned to the root node itself.

Optional Products

Products?: Product[]

The new components to be created.
If the first component has no Path, it's attributes will be merged into the already existing component (for which the Evaluator was called).

Methods

addEvaluatorParameter

  • Adds an Evaluator parameter. Requires that the array is already initialized.

    Parameters

    • path: string
    • parameter: string
    • value: any

    Returns void

addGeometryParameter

  • Adds an Geometry parameter. Requires that the array is already initialized.

    Parameters

    • path: string
    • parameter: string
    • value: any

    Returns void

addInteractorParameter

  • Adds an Interactor parameter. Requires that the array is already initialized.

    Parameters

    • path: string
    • parameter: string
    • value: any

    Returns void

finalize

  • Finalize the response. Evaluator parameters, embedded inside Products, will be extracted.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc