pack3d

Documentation

Index

• Constants
• Variables
• type AnnealCallback
• type Annealable
  • func Anneal(state Annealable, maxTemp, minTemp float64, steps int, callback AnnealCallback, ...) (Annealable, int)
• type AxesLock
• type Axis
  • func (a Axis) Vector() fauxgl.Vector
• type Config
  • func ParseConfig(input string) (*Config, error)
• type ConfigItem
  • func (c *ConfigItem) AvailableRotations() []fauxgl.Matrix
  • func (c *ConfigItem) ManufacturingOrientation() fauxgl.Matrix
• type Copack
• type Item
  • func (item *Item) Copy() *Item
  • func (item *Item) Matrix() fauxgl.Matrix
• type Model
  • func NewModel() *Model
  • func (m *Model) Add(mesh *fauxgl.Mesh, detail, count int, spacing float64, ...)
  • func (m *Model) BoundingBox() fauxgl.Box
  • func (m *Model) Copy() Annealable
  • func (m *Model) DoMove(singleStlSize []fauxgl.Vector, frameSize fauxgl.Vector, packItemNum int) (Undo, int)
  • func (m *Model) Energy() float64
  • func (m *Model) Mesh() *fauxgl.Mesh
  • func (m *Model) Meshes() []*fauxgl.Mesh
  • func (m *Model) Pack(iterations int, callback AnnealCallback, singleStlSize []fauxgl.Vector, ...) (*Model, int)
  • func (m *Model) Reset()
  • func (m *Model) Transformation() []fauxgl.Matrix
  • func (m *Model) TreeMesh() *fauxgl.Mesh
  • func (m *Model) TreeMeshes() []*fauxgl.Mesh
  • func (m *Model) UndoMove(undo Undo)
  • func (m *Model) ValidBound(i int, singleStlSize []fauxgl.Vector, frameSize fauxgl.Vector) bool
  • func (m *Model) ValidChange(i int) bool
  • func (m *Model) Volume() float64
• type Node
  • func NewNode(boxes []fauxgl.Box, depth int, space float64) *Node
  • func (a *Node) Flatten(tree Tree, i int)
  • func (node *Node) Split(boxes []fauxgl.Box, depth int, space float64)
• type PackingOutput
  • func Pack(config *Config) (*PackingOutput, error)
• type TransMap
• type Tree
  • func NewTreeForMesh(mesh *fauxgl.Mesh, depth int, spacing float64) Tree
  • func (a Tree) Intersects(b Tree, t1, t2 fauxgl.Vector) bool
  • func (a Tree) Transform(m fauxgl.Matrix) Tree
• type Undo

Constants

const (
	BVH_DETAIL           = 8
	ANNEALING_ITERATIONS = 2000000 // # of trials
)

Variables

var AxisXRotations []fauxgl.Matrix

var AxisYRotations []fauxgl.Matrix

var AxisZRotations []fauxgl.Matrix

Types

type AnnealCallback

type AnnealCallback func(Annealable)

type Annealable

type Annealable interface {
	Energy() float64
	DoMove([]fauxgl.Vector, fauxgl.Vector, int) (Undo, int)
	UndoMove(Undo)
	Copy() Annealable
}

func Anneal

func Anneal(state Annealable, maxTemp, minTemp float64, steps int, callback AnnealCallback, singleStlSize []fauxgl.Vector, frameSize fauxgl.Vector, packItemNum int) (Annealable, int)

type AxesLock

type AxesLock struct {
	ThetaX *float64 `json:"theta_x"`
	ThetaY *float64 `json:"theta_y"`
	ThetaZ *float64 `json:"theta_z"`
}

The struct name AxesLock is incorrect and should be replaced with MfgOrientation and corrected everywhere else in this file. This naming issue was spotted during the handoff to Tyler.

type Axis

type Axis uint8

const (
	AxisNone Axis = iota
	AxisX
	AxisY
	AxisZ
)

func (Axis) Vector

func (a Axis) Vector() fauxgl.Vector

type Config

type Config struct {
	BuildVolume [3]float64   `json:"build_volume"`
	Spacing     float64      `json:"spacing"`
	ConfigItems []ConfigItem `json:"items"`
}

func ParseConfig

func ParseConfig(input string) (*Config, error)

type ConfigItem

type ConfigItem struct {
	Filename string    `json:"filename"`
	Scale    float64   `json:"scale"`
	Count    int       `json:"count"`
	Copack   []*Copack `json:"copack,omitempty"`
	AxesLock *AxesLock `json:"axes_lock"`
}

func (*ConfigItem) AvailableRotations

func (c *ConfigItem) AvailableRotations() []fauxgl.Matrix

This function returns only the available rotations which depend on the unlocked axes provided by the user. An unlocked axis is characterised by a `nil` theta angle. Setting a theta angle with a Float instead means that that rotation axis is locked to a specific angle.

func (*ConfigItem) ManufacturingOrientation

func (c *ConfigItem) ManufacturingOrientation() fauxgl.Matrix

NOTE: The THREE.Euler's rotation order (in Rapidfab) has been set as 'ZYX' to match Blender's rotation order

and pack3d "seems" to be the same order of rotation but with the "minus" sign for all three angles.
e.g.: -fauxgl.Radians(*item.AxesLock.ThetaX)

type Copack

type Copack struct {
	Filename string `json:"filename"`
}

type Item

type Item struct {
	Mesh               *fauxgl.Mesh
	Trees              []Tree // struc tree -> []Box, struc Box -> {min, max} vector
	RotationId         int    // index of a rotation within Rotations.
	Translation        fauxgl.Vector
	AvailableRotations []fauxgl.Matrix
}

func (*Item) Copy

func (item *Item) Copy() *Item

func (*Item) Matrix

func (item *Item) Matrix() fauxgl.Matrix

type Model

type Model struct {
	Items     []*Item
	MinVolume float64
	MaxVolume float64
	Deviation float64
}

func NewModel

func NewModel() *Model

func (*Model) Add

func (m *Model) Add(mesh *fauxgl.Mesh, detail, count int, spacing float64, rotations []fauxgl.Matrix)

func (*Model) BoundingBox

func (m *Model) BoundingBox() fauxgl.Box

func (*Model) Copy

func (m *Model) Copy() Annealable

func (*Model) DoMove

func (m *Model) DoMove(singleStlSize []fauxgl.Vector, frameSize fauxgl.Vector, packItemNum int) (Undo, int)

func (*Model) Energy

func (m *Model) Energy() float64

func (*Model) Mesh

func (m *Model) Mesh() *fauxgl.Mesh

func (*Model) Meshes

func (m *Model) Meshes() []*fauxgl.Mesh

func (*Model) Pack

func (m *Model) Pack(iterations int, callback AnnealCallback, singleStlSize []fauxgl.Vector, frameSize fauxgl.Vector, packItemNum int) (*Model, int)

func (*Model) Reset

func (m *Model) Reset()

func (*Model) Transformation

func (m *Model) Transformation() []fauxgl.Matrix

This function will return the tranformation matrices of all items

func (*Model) TreeMesh

func (m *Model) TreeMesh() *fauxgl.Mesh

func (*Model) TreeMeshes

func (m *Model) TreeMeshes() []*fauxgl.Mesh

func (*Model) UndoMove

func (m *Model) UndoMove(undo Undo)

func (*Model) ValidBound

func (m *Model) ValidBound(i int, singleStlSize []fauxgl.Vector, frameSize fauxgl.Vector) bool

True if the passed move it within maximum_packing_area, false in all other cases.

func (*Model) ValidChange

func (m *Model) ValidChange(i int) bool

This function is to make sure no intersection between objects

func (*Model) Volume

func (m *Model) Volume() float64

type Node

type Node struct {
	Box   fauxgl.Box
	Left  *Node
	Right *Node
}

func NewNode

func NewNode(boxes []fauxgl.Box, depth int, space float64) *Node

func (*Node) Flatten

func (a *Node) Flatten(tree Tree, i int)

func (*Node) Split

func (node *Node) Split(boxes []fauxgl.Box, depth int, space float64)

type PackingOutput

type PackingOutput struct {
	Model    *Model
	MeshJSON []byte
}

func Pack

func Pack(config *Config) (*PackingOutput, error)

Attempts to pack a list of objects, applying rotation, scaling, and co-packing if specified.

type TransMap

type TransMap struct {
	Filename          string
	Transformation    [4][4]float64
	VolumeWithSpacing float64
}

type Tree

type Tree []fauxgl.Box

func NewTreeForMesh

func NewTreeForMesh(mesh *fauxgl.Mesh, depth int, spacing float64) Tree

func (Tree) Intersects

func (a Tree) Intersects(b Tree, t1, t2 fauxgl.Vector) bool

func (Tree) Transform

func (a Tree) Transform(m fauxgl.Matrix) Tree

type Undo

type Undo struct {
	Index       int
	Rotation    int
	Translation fauxgl.Vector
}