parameter

package

v0.37.0 Latest Latest Go to latest Published: Dec 20, 2025 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/EliCDavis/polyform

Links

Open Source Insights

Documentation ¶

Index ¶

type AABB
type Bool
type Color
type File
type FileNodeOutput
type Float32
type Float64
type Image
type Int
type String
type Value
type ValueSchema
type Vector2
type Vector3
type Vector3Array

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AABB ¶

type AABB = Value[geometry.AABB]

type Bool ¶

type Bool = Value[bool]

type Color ¶

type Color = Value[coloring.Color]

type File ¶

type File struct {
	Name        string
	Description string
	// contains filtered or unexported fields
}

func (*File) ApplyMessage ¶

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

func (*File) DisplayName ¶

func (pn *File) DisplayName() string

func (*File) FromJSON ¶

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

func (File) Inputs ¶

func (tn File) Inputs() map[string]nodes.InputPort

func (*File) Outputs ¶

func (tn *File) Outputs() map[string]nodes.OutputPort

func (*File) Schema ¶

func (pn *File) Schema() schema.Parameter

func (*File) SetDescription ¶ added in v0.21.3

func (in *File) SetDescription(description string)

func (*File) SetName ¶ added in v0.21.0

func (in *File) SetName(name string)

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

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
	Description string
	// contains filtered or unexported fields
}

func (*Image) ApplyMessage ¶

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

func (*Image) DisplayName ¶

func (pn *Image) DisplayName() string

func (*Image) FromJSON ¶

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

func (Image) Inputs ¶

func (tn Image) Inputs() map[string]nodes.InputPort

func (*Image) Outputs ¶

func (tn *Image) Outputs() map[string]nodes.OutputPort

func (*Image) Schema ¶

func (pn *Image) Schema() schema.Parameter

func (*Image) SetDescription ¶ added in v0.21.3

func (in *Image) SetDescription(description string)

func (*Image) SetName ¶ added in v0.21.0

func (in *Image) SetName(name string)

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

type Int ¶

type Int = Value[int]

type String ¶

type String = Value[string]

type Value ¶

type Value[T any] struct {
	Name        string `json:"name"`
	Description string `json:"description"`

	CurrentValue T
	// contains filtered or unexported fields
}

func (*Value[T]) ApplyMessage ¶

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

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]) Inputs ¶

func (tn Value[T]) Inputs() map[string]nodes.InputPort

func (*Value[T]) Outputs ¶

func (tn *Value[T]) Outputs() map[string]nodes.OutputPort

func (*Value[T]) Schema ¶

func (pn *Value[T]) Schema() schema.Parameter

func (*Value[T]) SetDescription ¶ added in v0.21.0

func (in *Value[T]) SetDescription(description string)

func (*Value[T]) SetName ¶ added in v0.21.0

func (in *Value[T]) SetName(name string)

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

type ValueSchema ¶

type ValueSchema[T any] struct {
	schema.ParameterBase
	CurrentValue T `json:"currentValue"`
}

type Vector2 ¶ added in v0.17.0

type Vector2 = Value[vector2.Float64]

type Vector3 ¶

type Vector3 = Value[vector3.Float64]

type Vector3Array ¶ added in v0.17.0

type Vector3Array = Value[[]vector3.Float64]

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL