.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Geometry::Primitive::Line 3pm" .TH Geometry::Primitive::Line 3pm "2018-03-30" "perl v5.26.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Geometry::Primitive::Line \- A Line .SH "DESCRIPTION" .IX Header "DESCRIPTION" Geometry::Primitive::Line represents a straight curve defined by two points. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Geometry::Primitive::Line; \& \& my $line = Geometry::Primitive::Line\->new(); \& $line\->start($point1); \& $line\->end($point2); .Ve .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" .SS "end" .IX Subsection "end" Set/Get the end point of the line. .SS "start" .IX Subsection "start" Set/Get the start point of the line. .SH "METHODS" .IX Header "METHODS" .SS "new" .IX Subsection "new" Creates a new Geometry::Primitive::Line .SS "contains_point" .IX Subsection "contains_point" Returns true if the supplied point is 'on' the line. Accepts either a point object or an x y pair. .SS "grow" .IX Subsection "grow" Does nothing, as I'm not sure how. Patches or hints welcome. .SS "is_parallel ($other_line)" .IX Subsection "is_parallel ($other_line)" Returns true if the supplied line is parallel to this one. .SS "is_perpendicular ($other_line)" .IX Subsection "is_perpendicular ($other_line)" Returns true if the supplied line is perpendicular to this one. .SS "length" .IX Subsection "length" Get the length of the line. .SS "point_end" .IX Subsection "point_end" Get the end point. Provided for Shape role. .SS "point_start" .IX Subsection "point_start" Get the start point. Provided for Shape role. .SS "scale" .IX Subsection "scale" Does nothing at the moment. .SS "slope" .IX Subsection "slope" Get the slope of the line. .SS "to_string" .IX Subsection "to_string" Guess! .SS "y_intercept" .IX Subsection "y_intercept" Returns the Y intercept of this line. .SH "AUTHOR" .IX Header "AUTHOR" Cory Watson .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" You can redistribute and/or modify this code under the same terms as Perl itself.