package nodeshape

Import Path
	github.com/pancsta/d2/d2layouts/d2talalayout/internal/nodeshape (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 4 packages

Involved Source Files

	  d shape.go
		Package nodeshape defines the shape-specific port and label-placement policy
		used by TALA nodes.

	    shape_c4person.go
	    shape_callout.go
	    shape_circle.go
	    shape_cloud.go
	    shape_cylinder.go
	    shape_diamond.go
	    shape_document.go
	    shape_hexagon.go
	    shape_image.go
	    shape_oval.go
	    shape_package.go
	    shape_page.go
	    shape_parallelogram.go
	    shape_person.go
	    shape_queue.go
	    shape_square.go
	    shape_step.go
	    shape_stored_data.go
	    shape_table.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Kind uint8 (basic type)
		Kind identifies the TALA behavior associated with a node shape.

		Methods (only one)
			( Kind) String() string
				String returns the D2 shape type represented by kind.

		Implements (at least 2)
			 Kind : expvar.Var
			 Kind : fmt.Stringer
		As Outputs Of (at least one exported)
			func New(typeName string, box *geo.Box) (Shape, Kind, bool)
		As Types Of (total 23)
			const C4Person
			const Callout
			const Circle
			const Class
			const Cloud
			const Code
			const Cylinder
			const Diamond
			const Document
			const Hexagon
			const Image
			const Oval
			const Package
			const Page
			const Parallelogram
			const Person
			const Queue
			const RealSquare
			const Square
			const Step
			const StoredData
			const Table
			const Text

	 type LabelTier int (basic type)
		LabelTier groups label positions by how suitable they are for a shape.

		As Inputs Of (at least one exported)
			func Shape.LabelPositionPreferences(tier LabelTier) map[label.Position]struct{}
		As Types Of (total 4)
			const Bad
			const Good
			const OK
			const Unideal

	 type Shape (interface)
		Shape extends D2's geometric shape with the ports and label-position policy
		needed by TALA.

		Methods (total 19)
			( Shape) AspectRatio1() bool
			( Shape) CenterPortIndex(orientation geo.Orientation) int
				CenterPortIndex returns the center port for an orientation, or -1 if the
				shape does not expose one.

			( Shape) CenterPortIndices() []int
				CenterPortIndices returns the center port on each side.

			( Shape) GetBox() *geo.Box
			( Shape) GetDefaultPadding() (paddingX, paddingY float64)
			( Shape) GetDimensionsToFit(width, height, paddingX, paddingY float64) (float64, float64)
			( Shape) GetInnerBox() *geo.Box
			( Shape) GetInnerBoxForContent(width, height float64) *geo.Box
				cloud shape has different innerBoxes depending on content's aspect ratio

			( Shape) GetInsidePlacement(width, height, paddingX, paddingY float64) geo.Point
				placing a rectangle of the given size and padding inside the shape, return the position relative to the shape's TopLeft

			( Shape) GetSVGPathData() []string
			( Shape) GetType() string
			( Shape) Is(shape string) bool
			( Shape) IsRectangular() bool
			( Shape) LabelPositionPreferences(tier LabelTier) map[label.Position]struct{}
				LabelPositionPreferences returns the positions in a preference tier.

			( Shape) MirroredPortIndices() map[int]int
				MirroredPortIndices maps each port index to its reflected counterpart.

			( Shape) Perimeter() []geo.Intersectable
				Perimeter returns a slice of geo.Intersectables that together constitute the shape border

			( Shape) PortIndices(orientation geo.Orientation) []int
				PortIndices returns the ports available for an orientation.

			( Shape) SetInnerBoxAspectRatio(aspectRatio float64)
			( Shape) SnapPointPercentages() [][]*geo.RelativePoint
				SnapPointPercentages returns port groups in top, left, bottom, and right order.

		Implemented By (at least one exported)
			 github.com/pancsta/d2/d2layouts/d2talalayout/internal/layoutgraph.Node
		Implements (at least one exported)
			 Shape : github.com/pancsta/d2/lib/shape.Shape
		As Outputs Of (at least one exported)
			func New(typeName string, box *geo.Box) (Shape, Kind, bool)
		As Inputs Of (at least 4)
			func NumColumns(s Shape) int
			func SetNumColumns(s Shape, numColumns int)
			func TableColumnPortValue(s Shape, orientation geo.Orientation, columnIndex int) (port geo.Point, ok bool)
			func TablePortIndex(s Shape, orientation geo.Orientation, columnIndex int) (index int, ok bool)


Package-Level Functions (total 5)

	 func New(typeName string, box *geo.Box) (Shape, Kind, bool)
		New constructs TALA's policy wrapper around a D2 shape. An empty type uses
		square behavior while retaining the empty D2 type. Unsupported nonempty types
		return ok=false so callers can preserve their existing shape.

	 func NumColumns(s Shape) int
		NumColumns returns the number of row-specific side ports for a table shape.
		Non-table shapes do not carry this metadata.

	 func SetNumColumns(s Shape, numColumns int)
		SetNumColumns updates the row-specific side ports for a table shape.
		It is a no-op for every other shape.

	 func TableColumnPortValue(s Shape, orientation geo.Orientation, columnIndex int) (port geo.Point, ok bool)
		TableColumnPortValue returns the table column's concrete side port without
		materializing all of the shape's snap points. Non-table shapes and non-side
		orientations return ok=false so callers can use their generic port policy.

	 func TablePortIndex(s Shape, orientation geo.Orientation, columnIndex int) (index int, ok bool)
		TablePortIndex returns the absolute snap-point index for a table column on
		the requested side. Non-table shapes and non-side orientations return
		ok=false so callers can use their generic port policy.


Package-Level Constants (total 27)

	const Bad LabelTier = 3
		Label preference tiers run from Good to Bad.

	const C4Person Kind = 12
		Shape kinds identify the policy wrapper returned by New.

	const Callout Kind = 9
		Shape kinds identify the policy wrapper returned by New.

	const Circle Kind = 15
		Shape kinds identify the policy wrapper returned by New.

	const Class Kind = 19
		Shape kinds identify the policy wrapper returned by New.

	const Cloud Kind = 17
		Shape kinds identify the policy wrapper returned by New.

	const Code Kind = 21
		Shape kinds identify the policy wrapper returned by New.

	const Cylinder Kind = 4
		Shape kinds identify the policy wrapper returned by New.

	const Diamond Kind = 13
		Shape kinds identify the policy wrapper returned by New.

	const Document Kind = 3
		Shape kinds identify the policy wrapper returned by New.

	const Good LabelTier = 0
		Label preference tiers run from Good to Bad.

	const Hexagon Kind = 16
		Shape kinds identify the policy wrapper returned by New.

	const Image Kind = 22
		Shape kinds identify the policy wrapper returned by New.

	const OK LabelTier = 1
		Label preference tiers run from Good to Bad.

	const Oval Kind = 14
		Shape kinds identify the policy wrapper returned by New.

	const Package Kind = 7
		Shape kinds identify the policy wrapper returned by New.

	const Page Kind = 6
		Shape kinds identify the policy wrapper returned by New.

	const Parallelogram Kind = 2
		Shape kinds identify the policy wrapper returned by New.

	const Person Kind = 11
		Shape kinds identify the policy wrapper returned by New.

	const Queue Kind = 5
		Shape kinds identify the policy wrapper returned by New.

	const RealSquare Kind = 1
		Shape kinds identify the policy wrapper returned by New.

	const Square Kind = 0
		Shape kinds identify the policy wrapper returned by New.

	const Step Kind = 8
		Shape kinds identify the policy wrapper returned by New.

	const StoredData Kind = 10
		Shape kinds identify the policy wrapper returned by New.

	const Table Kind = 18
		Shape kinds identify the policy wrapper returned by New.

	const Text Kind = 20
		Shape kinds identify the policy wrapper returned by New.

	const Unideal LabelTier = 2
		Label preference tiers run from Good to Bad.

The pages are generated with Golds v0.8.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.