parameter

package
v0.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 14, 2024 License: MIT Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Nodes 

func Nodes() *refutil.TypeFactory

Types

type AABB 

type AABB = Value[geometry.AABB]

type Bool 

type Bool = Value[bool]

type CliConfig 

type CliConfig[T any] struct {
	FlagName string `json:"flagName"`
	Usage    string `json:"usage"`
	// contains filtered or unexported fields
}

type Color 

type Color = Value[coloring.WebColor]

type File 

type File struct {
	Name         string
	DefaultValue []byte
	CLI          *CliConfig[string]
	// contains filtered or unexported fields
}

func (*File) ApplyMessage 

func (pn *File) ApplyMessage(msg []byte) (bool, error)

func (*File) Dependencies 

func (pn *File) Dependencies() []nodes.NodeDependency

func (*File) DisplayName 

func (pn *File) DisplayName() string

func (*File) FromJSON 

func (pn *File) FromJSON(decoder jbtf.Decoder, body []byte) (err error)

func (File) InitializeForCLI 

func (pn File) InitializeForCLI(set *flag.FlagSet)

func (File) Inputs 

func (tn File) Inputs() []nodes.Input

func (*File) Node 

func (in *File) Node() nodes.Node

func (*File) Out 

func (tn *File) Out() FileNodeOutput

func (*File) Outputs 

func (tn *File) Outputs() []nodes.Output

func (File) Port 

func (in File) Port() string

func (*File) Schema 

func (pn *File) Schema() generator.ParameterSchema

func (File) SetInput 

func (vn File) SetInput(input string, output nodes.Output)

func (*File) State 

func (pn *File) State() nodes.NodeState

func (*File) ToJSON 

func (pn *File) ToJSON(encoder *jbtf.Encoder) ([]byte, error)

func (*File) ToMessage 

func (pn *File) ToMessage() []byte

func (*File) Value 

func (pn *File) Value() []byte

func (File) Version 

func (pn File) Version() int

type FileNodeOutput 

type FileNodeOutput struct {
	Val *File
}

func (FileNodeOutput) Node 

func (sno FileNodeOutput) Node() nodes.Node

func (FileNodeOutput) Port 

func (sno FileNodeOutput) Port() string

func (FileNodeOutput) Value 

func (sno FileNodeOutput) Value() []byte

type Float32 

type Float32 = Value[float32]

type Float64 

type Float64 = Value[float64]

Common types for shorthand purposes

type Image 

type Image struct {
	Name         string
	DefaultValue image.Image
	CLI          *CliConfig[string]
	// contains filtered or unexported fields
}

func (*Image) AddSubscription 

func (pn *Image) AddSubscription(a nodes.Alertable)

func (*Image) ApplyMessage 

func (pn *Image) ApplyMessage(msg []byte) (bool, error)

func (*Image) Dependencies 

func (pn *Image) Dependencies() []nodes.NodeDependency

func (*Image) DisplayName 

func (pn *Image) DisplayName() string

func (*Image) FromJSON 

func (pn *Image) FromJSON(decoder jbtf.Decoder, body []byte) (err error)

func (Image) InitializeForCLI 

func (pn Image) InitializeForCLI(set *flag.FlagSet)

func (Image) Inputs 

func (tn Image) Inputs() []nodes.Input

func (*Image) Node 

func (in *Image) Node() nodes.Node

func (*Image) Out 

func (tn *Image) Out() ImageNodeOutput

func (*Image) Outputs 

func (tn *Image) Outputs() []nodes.Output

func (Image) Port 

func (in Image) Port() string

func (*Image) Schema 

func (pn *Image) Schema() generator.ParameterSchema

func (Image) SetInput 

func (vn Image) SetInput(input string, output nodes.Output)

func (*Image) State 

func (pn *Image) State() nodes.NodeState

func (*Image) ToJSON 

func (pn *Image) ToJSON(encoder *jbtf.Encoder) ([]byte, error)

func (*Image) ToMessage 

func (pn *Image) ToMessage() []byte

func (*Image) Value 

func (pn *Image) Value() image.Image

func (Image) Version 

func (pn Image) Version() int

type ImageNodeOutput 

type ImageNodeOutput struct {
	Val *Image
}

func (ImageNodeOutput) Node 

func (sno ImageNodeOutput) Node() nodes.Node

func (ImageNodeOutput) Port 

func (sno ImageNodeOutput) Port() string

func (ImageNodeOutput) Value 

func (sno ImageNodeOutput) Value() image.Image

type Int 

type Int = Value[int]

type ParameterNodeOutput 

type ParameterNodeOutput[T any] struct {
	Val *Value[T]
}

func (ParameterNodeOutput[T]) Node 

func (sno ParameterNodeOutput[T]) Node() nodes.Node

func (ParameterNodeOutput[T]) Port 

func (sno ParameterNodeOutput[T]) Port() string

func (ParameterNodeOutput[T]) Value 

func (sno ParameterNodeOutput[T]) Value() T

type String 

type String = Value[string]

type Value 

type Value[T any] struct {
	Name         string        `json:"name"`
	Description  string        `json:"description"`
	DefaultValue T             `json:"defaultValue"`
	CLI          *CliConfig[T] `json:"cli"`
	// contains filtered or unexported fields
}

func (*Value[T]) AddSubscription 

func (pn *Value[T]) AddSubscription(a nodes.Alertable)

func (*Value[T]) ApplyMessage 

func (pn *Value[T]) ApplyMessage(msg []byte) (bool, error)

func (*Value[T]) Dependencies 

func (pn *Value[T]) Dependencies() []nodes.NodeDependency

func (*Value[T]) DisplayName 

func (pn *Value[T]) DisplayName() string

func (*Value[T]) FromJSON 

func (pn *Value[T]) FromJSON(decoder jbtf.Decoder, body []byte) (err error)

func (Value[T]) InitializeForCLI 

func (pn Value[T]) InitializeForCLI(set *flag.FlagSet)

func (Value[T]) Inputs 

func (tn Value[T]) Inputs() []nodes.Input

func (*Value[T]) Node 

func (in *Value[T]) Node() nodes.Node

func (*Value[T]) Out 

func (tn *Value[T]) Out() nodes.NodeOutput[T]

func (*Value[T]) Outputs 

func (tn *Value[T]) Outputs() []nodes.Output

func (*Value[T]) Port 

func (in *Value[T]) Port() string

func (*Value[T]) Schema 

func (pn *Value[T]) Schema() generator.ParameterSchema

func (Value[T]) SetInput 

func (vn Value[T]) SetInput(input string, output nodes.Output)

func (*Value[T]) State 

func (pn *Value[T]) State() nodes.NodeState

func (Value[T]) SwaggerProperty 

func (pn Value[T]) SwaggerProperty() swagger.Property

func (*Value[T]) ToJSON 

func (pn *Value[T]) ToJSON(encoder *jbtf.Encoder) ([]byte, error)

func (Value[T]) ToMessage 

func (pn Value[T]) ToMessage() []byte

func (*Value[T]) Value 

func (pn *Value[T]) Value() T

func (Value[T]) Version 

func (pn Value[T]) Version() int

type ValueSchema 

type ValueSchema[T any] struct {
	generator.ParameterSchemaBase
	DefaultValue T `json:"defaultValue"`
	CurrentValue T `json:"currentValue"`
}

type Vector3 

type Vector3 = Value[vector3.Float64]

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.