| Copyright | (c) 2012-2015 diagrams-core team (see LICENSE) |
|---|---|
| License | BSD-style (see LICENSE) |
| Maintainer | diagrams-discuss@googlegroups.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Diagrams.Core.Trace
Description
diagrams-core defines the core library of primitives
forming the basis of an embedded domain-specific language for
describing and rendering diagrams.
The Trace module defines a data type and type class for
"traces", aka functional boundaries, essentially corresponding to
embedding a raytracer with each diagram.
- data SortedList a
- mkSortedList :: Ord a => [a] -> SortedList a
- getSortedList :: SortedList a -> [a]
- onSortedList :: Ord b => ([a] -> [b]) -> SortedList a -> SortedList b
- unsafeOnSortedList :: ([a] -> [b]) -> SortedList a -> SortedList b
- newtype Trace v n = Trace {
- appTrace :: Point v n -> v n -> SortedList n
- mkTrace :: (Point v n -> v n -> SortedList n) -> Trace v n
- class (Additive (V a), Ord (N a)) => Traced a where
- traceV :: (n ~ N a, Num n, Traced a) => Point (V a) n -> V a n -> a -> Maybe (V a n)
- traceP :: (n ~ N a, Traced a, Num n) => Point (V a) n -> V a n -> a -> Maybe (Point (V a) n)
- maxTraceV :: (n ~ N a, Num n, Traced a) => Point (V a) n -> V a n -> a -> Maybe (V a n)
- maxTraceP :: (n ~ N a, Num n, Traced a) => Point (V a) n -> V a n -> a -> Maybe (Point (V a) n)
- getRayTrace :: (n ~ N a, Traced a, Num n) => a -> Trace (V a) n
- rayTraceV :: (n ~ N a, Traced a, Num n) => Point (V a) n -> V a n -> a -> Maybe (V a n)
- rayTraceP :: (n ~ N a, Traced a, Num n) => Point (V a) n -> V a n -> a -> Maybe (Point (V a) n)
- maxRayTraceV :: (n ~ N a, Traced a, Num n) => Point (V a) n -> V a n -> a -> Maybe (V a n)
- maxRayTraceP :: (n ~ N a, Traced a, Num n) => Point (V a) n -> V a n -> a -> Maybe (Point (V a) n)
SortedList
data SortedList a #
A newtype wrapper around a list which maintains the invariant
that the list is sorted. The constructor is not exported; use
the smart constructor mkSortedList (which sorts the given list)
instead.
Instances
| Ord a => Semigroup (SortedList a) # |
|
| Ord a => Monoid (SortedList a) # |
|
mkSortedList :: Ord a => [a] -> SortedList a #
A smart constructor for the SortedList type, which sorts the
input to ensure the SortedList invariant.
getSortedList :: SortedList a -> [a] #
Project the (guaranteed sorted) list out of a SortedList
wrapper.
onSortedList :: Ord b => ([a] -> [b]) -> SortedList a -> SortedList b #
Apply a list function to a SortedList. The function need not
result in a sorted list; the result will be sorted before being
rewrapped as a SortedList.
unsafeOnSortedList :: ([a] -> [b]) -> SortedList a -> SortedList b #
Apply an order-preserving list function to a SortedList. No
sorts or checks are done.
Traces
Every diagram comes equipped with a trace. Intuitively, the trace for a diagram is like a raytracer: given a line (represented as a base point and a direction vector), the trace computes a sorted list of signed distances from the base point to all intersections of the line with the boundary of the diagram.
Note that the outputs are not absolute distances, but multipliers
relative to the input vector. That is, if the base point is p
and direction vector is v, and one of the output scalars is
s, then there is an intersection at the point p .+^ (s *^ v).
Constructors
| Trace | |
Fields
| |
Instances
| Show (Trace v n) # | |
| Ord n => Semigroup (Trace v n) # | |
| Ord n => Monoid (Trace v n) # | |
| Wrapped (Trace v n) # | |
| (Additive v, Num n) => HasOrigin (Trace v n) # | |
| (Additive v, Num n) => Transformable (Trace v n) # | |
| (Additive v, Ord n) => Traced (Trace v n) # | |
| Rewrapped (Trace v n) (Trace v' n') # | |
| type Unwrapped (Trace v n) # | |
| type N (Trace v n) # | |
| type V (Trace v n) # | |
mkTrace :: (Point v n -> v n -> SortedList n) -> Trace v n #
Traced class
class (Additive (V a), Ord (N a)) => Traced a where #
Traced abstracts over things which have a trace.
Minimal complete definition
Instances
| Traced b => Traced [b] # | |
| Traced b => Traced (Set b) # | |
| Traced t => Traced (TransInv t) # | |
| (Traced a, Traced b, SameSpace a b) => Traced (a, b) # | |
| Traced b => Traced (Map k b) # | |
| (Additive v, Ord n) => Traced (Point v n) # | The trace of a single point is the empty trace, i.e. the one which returns no intersection points for every query. Arguably it should return a single finite distance for vectors aimed directly at the given point, but due to floating-point inaccuracy this is problematic. Note that the envelope for a single point is not the empty envelope (see Diagrams.Core.Envelope). |
| (Additive v, Ord n) => Traced (Trace v n) # | |
| (OrderedField n, Metric v, Semigroup m) => Traced (Subdiagram b v n m) # | |
| (Metric v, OrderedField n, Semigroup m) => Traced (QDiagram b v n m) # | |
Computing with traces
traceV :: (n ~ N a, Num n, Traced a) => Point (V a) n -> V a n -> a -> Maybe (V a n) #
Compute the vector from the given point p to the "smallest"
boundary intersection along the given vector v. The
"smallest" boundary intersection is defined as the one given by
p .+^ (s *^ v) for the smallest (most negative) value of
s. Return Nothing if there is no intersection. See also
traceP.
See also rayTraceV which uses the smallest positive
intersection, which is often more intuitive behavior.
traceP :: (n ~ N a, Traced a, Num n) => Point (V a) n -> V a n -> a -> Maybe (Point (V a) n) #
Compute the "smallest" boundary point along the line determined
by the given point p and vector v. The "smallest" boundary
point is defined as the one given by p .+^ (s *^ v) for
the smallest (most negative) value of s. Return Nothing if
there is no such boundary point. See also traceV.
See also rayTraceP which uses the smallest positive
intersection, which is often more intuitive behavior.
maxTraceV :: (n ~ N a, Num n, Traced a) => Point (V a) n -> V a n -> a -> Maybe (V a n) #
Like traceV, but computes a vector to the "largest" boundary
point instead of the smallest. (Note, however, the "largest"
boundary point may still be in the opposite direction from the
given vector, if all the boundary points are, as in the third
example shown below.)
maxTraceP :: (n ~ N a, Num n, Traced a) => Point (V a) n -> V a n -> a -> Maybe (Point (V a) n) #
Like traceP, but computes the "largest" boundary point
instead of the smallest. (Note, however, the "largest" boundary
point may still be in the opposite direction from the given
vector, if all the boundary points are.)
rayTraceV :: (n ~ N a, Traced a, Num n) => Point (V a) n -> V a n -> a -> Maybe (V a n) #
Compute the vector from the given point to the closest boundary
point of the given object in the given direction, or Nothing if
there is no such boundary point (as in the third example
below). Note that unlike traceV, only positive boundary
points are considered, i.e. boundary points corresponding to a
positive scalar multiple of the direction vector. This is
intuitively the "usual" behavior of a raytracer, which only
considers intersections "in front of" the camera. Compare the
second example diagram below with the second example shown for
traceV.
rayTraceP :: (n ~ N a, Traced a, Num n) => Point (V a) n -> V a n -> a -> Maybe (Point (V a) n) #
Compute the boundary point on an object which is closest to the
given base point in the given direction, or Nothing if there is
no such boundary point. Note that unlike traceP, only positive
boundary points are considered, i.e. boundary points
corresponding to a positive scalar multiple of the direction
vector. This is intuitively the "usual" behavior of a raytracer,
which only considers intersection points "in front of" the
camera.
