Interface PolytronInputParameter

The PolytronInputParameter interface represents an input parameter.

interface PolytronInputParameter {
    ColorSpace?: "sRGB" | "Linear";
    EnumTypeProvider?: PolytronEnumTypeProvider;
    FileFormatTypes?: string[];
    FriendlyName?: string;
    ID: string;
    Meta?: PolytronObjectMeta;
    Name: string;
    String?: string;
    URL?: string;
    Value?: string | number | boolean;
    VariableType: string;
}

Properties

ColorSpace? EnumTypeProvider? FileFormatTypes? FriendlyName? ID Meta? Name String? URL? Value? VariableType

Properties

OptionalColorSpace

ColorSpace?: "sRGB" | "Linear"

Defines the output color space. Valid for image types. Default: "sRGB"

OptionalEnumTypeProvider

EnumTypeProvider?: PolytronEnumTypeProvider

The enum type provider, for enum types.

OptionalFileFormatTypes

FileFormatTypes?: string[]

OptionalFriendlyName

FriendlyName?: string

The friendly name used for display.

ID

ID: string

The unique parameter ID.

OptionalMeta

Meta?: PolytronObjectMeta

The meta data.

Name

Name: string

The unique name, no other parameter on the Polytron may have the same name.

OptionalString

String?: string

The string value, for string types.

OptionalURL

URL?: string

The URL for the resource, for resource based types such as images or meshes.

OptionalValue

Value?: string | number | boolean

The arithemtic value, for arithemtic types.

VariableType

VariableType: string

The variable type.

Settings

Member Visibility

On This Page

Properties