diff options
author | Norbert Preining <norbert@preining.info> | 2021-10-03 03:01:24 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2021-10-03 03:01:24 +0000 |
commit | c7bf3f5a728fcb426d1aa38fbec211d4344a3725 (patch) | |
tree | 87fbde2d0e79f9e5fce12cbb71971717568fbf9d /graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Node.3 | |
parent | ac5a96ddb02c62d71eb214ed35e3be9a154d991f (diff) |
CTAN sync 202110030301
Diffstat (limited to 'graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Node.3')
-rw-r--r-- | graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Node.3 | 232 |
1 files changed, 101 insertions, 131 deletions
diff --git a/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Node.3 b/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Node.3 index 0c6dba5c79..e4a9d16877 100644 --- a/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Node.3 +++ b/graphics/pstricks/contrib/pedigree/pedigree-perl/Pedigree/Node.3 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05) +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== @@ -38,27 +38,36 @@ . 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 turned on, we'll generate index entries on stderr for +.\" 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. -.ie \nF \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX .. -. nr % 0 -. rr F -.\} -.el \{\ -. de IX +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} .\} +.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -124,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "Pedigree::Node 3" -.TH Pedigree::Node 3 "2009-01-05" "perl v5.10.0" "User Contributed Perl Documentation" +.TH Pedigree::Node 3 "2021-10-02" "perl v5.18.4" "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 @@ -137,35 +146,35 @@ use Pedigree::Node; .PP \&\f(CW$node\fR = new Pedigree::Node(\fI\f(CI%params\fI\fR); .PP -\&\f(CW$node\fR\->\fICheckAllParents()\fR; +\&\f(CW$node\fR\->\fBCheckAllParents()\fR; .PP -\&\f(CW$Id\fR = \f(CW$node\fR\->\fIId()\fR; +\&\f(CW$Id\fR = \f(CW$node\fR\->\fBId()\fR; .PP \&\f(CW$node\fR\->SetSortOrder(\-1|0|1); .PP -\&\f(CW$result\fR = \f(CW$node\fR\->\fISortOrder()\fR; +\&\f(CW$result\fR = \f(CW$node\fR\->\fBSortOrder()\fR; .PP -\&\f(CW$is_numbered\fR=$node\->\fIisNumbered()\fR; +\&\f(CW$is_numbered\fR=$node\->\fBisNumbered()\fR; .PP -\&\f(CW$type\fR = \f(CW$node\fR\->\fIType()\fR; +\&\f(CW$type\fR = \f(CW$node\fR\->\fBType()\fR; .PP -\&\f(CW$Kids\fR = \f(CW$node\fR\->\fIKids()\fR; +\&\f(CW$Kids\fR = \f(CW$node\fR\->\fBKids()\fR; .PP -\&\f(CW$node\fR\->\fIGetAndSortKids()\fR; +\&\f(CW$node\fR\->\fBGetAndSortKids()\fR; .PP ($root, \f(CW$newgen\fR) = \f(CW$node\fR\->FindRoot(\fI\f(CI$generation\fI\fR, [\fI\f(CI$sort_order\fI\fR]); .PP -\&\f(CW$x\fR = \f(CW$node\fR\->\fIGetRelX()\fR; +\&\f(CW$x\fR = \f(CW$node\fR\->\fBGetRelX()\fR; .PP -\&\f(CW$y\fR = \f(CW$node\fR\->\fIGetRelY()\fR; +\&\f(CW$y\fR = \f(CW$node\fR\->\fBGetRelY()\fR; .PP \&\f(CW$node\fR\->SetRelX(\fI\f(CI$x\fI\fR); .PP \&\f(CW$node\fR\->SetRelX(\fI\f(CI$y\fI\fR); .PP -\&\f(CW$x\fR = \f(CW$node\fR\->\fIGetAbsX()\fR; +\&\f(CW$x\fR = \f(CW$node\fR\->\fBGetAbsX()\fR; .PP -\&\f(CW$y\fR = \f(CW$node\fR\->\fIGetAbsY()\fR; +\&\f(CW$y\fR = \f(CW$node\fR\->\fBGetAbsY()\fR; .PP \&\f(CW$node\fR\->SetIndexX(\fI\f(CI$n\fI\fR); .PP @@ -173,15 +182,15 @@ use Pedigree::Node; .PP \&\f(CW$node\fR\->SetAbsY(\fI\f(CI$y\fI\fR); .PP -\&\f(CW$n\fR = \f(CW$node\fR\->\fIGetIndexX()\fR; +\&\f(CW$n\fR = \f(CW$node\fR\->\fBGetIndexX()\fR; .PP -\&\f(CW$area\fR = \f(CW$node\fR\->\fISetArea()\fR; +\&\f(CW$area\fR = \f(CW$node\fR\->\fBSetArea()\fR; .PP -\&\f(CW$delta\fR = \f(CW$node\fR\->\fICenterKids()\fR; +\&\f(CW$delta\fR = \f(CW$node\fR\->\fBCenterKids()\fR; .PP \&\f(CW$node\fR\->CalcAbsCoord(\fI\f(CI$x\fI\fR, \fI\f(CI$y\fI\fR); .PP -\&\f(CW$node\fR\->\fIAddConsanguinicMarriages()\fR; +\&\f(CW$node\fR\->\fBAddConsanguinicMarriages()\fR; .PP \&\f(CW$node\fR\->AddTwins($ydist); .PP @@ -190,7 +199,7 @@ use Pedigree::Node; \&\f(CW$node\fR\->DrawAll(\fI\f(CI$xdist\fI\fR, \fI\f(CI$ydist\fI\fR, \fI\f(CI$belowtextfont\fI\fR, \fI\f(CI$abovetextfont\fI\fR, \fI\f(CI@fieldsfornode\fI\fR); .PP -\&\f(CW$node\fR\->\fIDrawConnections()\fR; +\&\f(CW$node\fR\->\fBDrawConnections()\fR; .PP \&\f(CW$node\fR\->PrintAllLegends(\fI\f(CI$land\fI\fR, \fI\f(CI@fields\fI\fR); .PP @@ -198,182 +207,143 @@ use Pedigree::Node; .SH "DESCRIPTION" .IX Header "DESCRIPTION" This is the basic package that defines nodes for pedigrees. -\&\fIPedigree::PersonNode\fR\|(3) and \fIPedigree::MarriageNode\fR\|(3) inherit from +\&\fBPedigree::PersonNode\fR\|(3) and \fBPedigree::MarriageNode\fR\|(3) inherit from this package. -.Sp -.RS 4 -\&\fBnew\fR(\fI\f(CI%params\fI\fR); -.Sp +.IP "\fBnew\fR(\fI\f(CI%params\fI\fR);" 4 +.IX Item "new(%params);" Construct a new node from the given parameters. If a node with the give Id exists, add new information to the node. -.Sp -\&\fBCheckAllParents\fR(); -.Sp +.IP "\fBCheckAllParents\fR();" 4 +.IX Item "CheckAllParents();" Check whether mothers and fathers of all nodes exist -.Sp -\&\fBId\fR(); -.Sp +.IP "\fBId\fR();" 4 +.IX Item "Id();" Get Id of a node. Note that there is no way to set an Id of a node that was already created. -.Sp -\&\fBSetSortOrder\fR(\fI\-1|0|1\fR); -.Sp +.IP "\fBSetSortOrder\fR(\fI\-1|0|1\fR);" 4 +.IX Item "SetSortOrder(-1|0|1);" Normally the sibs nodes are sorted by age. However, if the nodes or their descendants are connected by a marriage line, we must sort them in the special way: all way to the left or all way to the right. The procedure \fBSetSortOrder\fR sets this flag for the node or deletes it depending on the argument. -.Sp -\&\fBSortOrder\fR(); -.Sp +.IP "\fBSortOrder\fR();" 4 +.IX Item "SortOrder();" Normally the sibs nodes are sorted by age. However, if the nodes or their descendants are connected by a marriage line, we must sort them in the special way: all way to the left or all way to the right. The procedure \fBSortOrder\fR checks this flag. -.Sp -\&\fBisNumbered\fR(); -.Sp +.IP "\fBisNumbered\fR();" 4 +.IX Item "isNumbered();" Check whether the node should be numbered in pedigree -.Sp -\&\fBType\fR() -.Sp +.IP "\fBType\fR()" 4 +.IX Item "Type()" Return node type. -.Sp -\&\fBKids\fR(); -.Sp +.IP "\fBKids\fR();" 4 +.IX Item "Kids();" Get the reference to the array of kids -.Sp -\&\fBGetAndSortKids\fR(); -.Sp +.IP "\fBGetAndSortKids\fR();" 4 +.IX Item "GetAndSortKids();" Apply sort the array of kids for the given node -.Sp -\&\fBFindRoot\fR(\fI\f(CI$generation\fI\fR, [\fI\f(CI$sort_order\fI\fR]); -.Sp +.IP "\fBFindRoot\fR(\fI\f(CI$generation\fI\fR, [\fI\f(CI$sort_order\fI\fR]);" 4 +.IX Item "FindRoot($generation, [$sort_order]);" Finds the root of the tree to which the current node belongs. Takes the current generation number and returns the root and its generation number. Here generation numbers go \*(L"backwards\*(R": the older generations have higher numbers. The found node is assigned sort order \&\fI\f(CI$sort_order\fI\fR. -.Sp -\&\fBGetRelX\fR(); -.Sp +.IP "\fBGetRelX\fR();" 4 +.IX Item "GetRelX();" Find the relative x coordinate of the node. The coordinate is relative to the precedessor or to the marriage node, which connects this node to the proband -.Sp -\&\fBGetRelY\fR(); -.Sp +.IP "\fBGetRelY\fR();" 4 +.IX Item "GetRelY();" Find the relative Y coordinate of the node. The coordinate is relative to the precedessor or to the marriage node, which connects this node to the proband. Note that the Y axis is down. -.Sp -\&\fBSetRelX\fR(\fI\f(CI$x\fI\fR); -.Sp +.IP "\fBSetRelX\fR(\fI\f(CI$x\fI\fR);" 4 +.IX Item "SetRelX($x);" Set the relative x coordinate of the node. The coordinate is relative to the precedessor or to the marriage node, which connects this node to the proband. -.Sp -\&\fBSetRelY\fR(\fI\f(CI$y\fI\fR); -.Sp +.IP "\fBSetRelY\fR(\fI\f(CI$y\fI\fR);" 4 +.IX Item "SetRelY($y);" Set the relative y coordinate of the node. The coordinate is relative to the precedessor or to the marriage node, which connects this node to the proband. Note that the Y axis is down. -.Sp -\&\fBGetAbsX\fR(); -.Sp +.IP "\fBGetAbsX\fR();" 4 +.IX Item "GetAbsX();" Find the absolute x coordinate of the node. -.Sp -\&\fBGetAbsY\fR(); -.Sp +.IP "\fBGetAbsY\fR();" 4 +.IX Item "GetAbsY();" Find the absolute Y coordinate of the node. -.Sp -\&\fBGetIndexX\fR(); -.Sp +.IP "\fBGetIndexX\fR();" 4 +.IX Item "GetIndexX();" Find the number of the node in the given generation. -.Sp -\&\fBSetAbsX\fR(\fI\f(CI$x\fI\fR); -.Sp +.IP "\fBSetAbsX\fR(\fI\f(CI$x\fI\fR);" 4 +.IX Item "SetAbsX($x);" Set the absolute x coordinate of the node. -.Sp -\&\fBSetAbsY\fR(\fI\f(CI$y\fI\fR); -.Sp +.IP "\fBSetAbsY\fR(\fI\f(CI$y\fI\fR);" 4 +.IX Item "SetAbsY($y);" Set the absolute y coordinate of the node. -.Sp -\&\fBSetIndexX\fR(\fI\f(CI$n\fI\fR); -.Sp +.IP "\fBSetIndexX\fR(\fI\f(CI$n\fI\fR);" 4 +.IX Item "SetIndexX($n);" Set the number of the node in the given generation. -.Sp -\&\fBSetArea\fR(); -.Sp +.IP "\fBSetArea\fR();" 4 +.IX Item "SetArea();" Calculate relative coordinates for all nodes, that are descendants of -the given node. We create a \fIPedigree::Area\fR\|(3) around the given node +the given node. We create a \fBPedigree::Area\fR\|(3) around the given node and recursively apply the function to all descendants. The subroutine returns the reference to the created area. -.Sp -\&\fBCenterKids\fR(); -.Sp +.IP "\fBCenterKids\fR();" 4 +.IX Item "CenterKids();" Move the relative coordinates of all the kids of the given node so the given node is centered in relation to the kids. Returns -the shift to be applied to the \fIPedigree::Area\fR\|(3). -.Sp -\&\fBCalcAbsCoor\fR(\fI\f(CI$x\fI\fR, $<y>); -.Sp +the shift to be applied to the \fBPedigree::Area\fR\|(3). +.IP "\fBCalcAbsCoor\fR(\fI\f(CI$x\fI\fR, $<y>);" 4 +.IX Item "CalcAbsCoor($x, $<y>);" Set the absolute coordinates of the given node, if the absolute coordinates of the parent node are (\fI\f(CI$x\fI\fR, \fI\f(CI$y\fI\fR), and recursively do this for all descendants of this node. Additionally set up \&\fB\f(CB%node_by_gen\fB\fR. -.Sp -\&\fBAddConsanguinicMarriages\fR(); -.Sp +.IP "\fBAddConsanguinicMarriages\fR();" 4 +.IX Item "AddConsanguinicMarriages();" Check the pedigree and add consanguinic marriages to it. Note that this procedure must be called \fBafter\fR SetAbsCoor, so the coordinates of all nodes are set. -.Sp -\&\fBAddTwins\fR(\fI\f(CI$ydist\fI\fR); -.Sp +.IP "\fBAddTwins\fR(\fI\f(CI$ydist\fI\fR);" 4 +.IX Item "AddTwins($ydist);" Check the pedigree and add twin nodes. Note that this procedure must be called \fBafter\fR SetAbsCoor and AddConsanguinicMarriages. -.Sp -\&\fBSetFrame\fR(\fI\f(CI$xidst\fI\fR, \fI\f(CI$ydist\fI\fR); -.Sp +.IP "\fBSetFrame\fR(\fI\f(CI$xidst\fI\fR, \fI\f(CI$ydist\fI\fR);" 4 +.IX Item "SetFrame($xidst, $ydist);" Calculate the frame: coordinates of the lower left and upper right corners of the picture (in ps units). As a side effect, add generation numbers to each person node and calculate the X index of each node. -.Sp -\&\fBDrawConnections\fR(); -.Sp +.IP "\fBDrawConnections\fR();" 4 +.IX Item "DrawConnections();" Draw the connections from the given node to its descendants -.Sp -\&\fBDrawAll\fR(\fI\f(CI$xdist\fI\fR, \fI\f(CI$ydist\fI\fR, \fI\f(CI$belowtextfont\fI\fR, - \fI\f(CI$abovetextfont\fI\fR, \fI\f(CI@fieldsfornode\fI\fR); -.Sp +.IP "\fBDrawAll\fR(\fI\f(CI$xdist\fI\fR, \fI\f(CI$ydist\fI\fR, \fI\f(CI$belowtextfont\fI\fR, \fI\f(CI$abovetextfont\fI\fR, \fI\f(CI@fieldsfornode\fI\fR);" 4 +.IX Item "DrawAll($xdist, $ydist, $belowtextfont, $abovetextfont, @fieldsfornode);" Draw all nodes and connections in the form suitable for pspicture -.Sp -\&\fBPrintAllLegends\fR(\fI\f(CI$lang\fI\fR, \fI\f(CI@fields\fI\fR); -.Sp +.IP "\fBPrintAllLegends\fR(\fI\f(CI$lang\fI\fR, \fI\f(CI@fields\fI\fR);" 4 +.IX Item "PrintAllLegends($lang, @fields);" Print legend for all the nodes. The first parameter is the language, the other is the fields to be included in the legend. -.Sp -\&\fBPrintLegend\fR(\fI\f(CI$lang\fI\fR, \fI\f(CI@fields\fI\fR); -.Sp +.IP "\fBPrintLegend\fR(\fI\f(CI$lang\fI\fR, \fI\f(CI@fields\fI\fR);" 4 +.IX Item "PrintLegend($lang, @fields);" This subroutine does nothing: a generic node has no legend. It -is overriden by \fIPedigree::PersonNode\fR\|(3) and \fIPedigree::AbortionNode\fR\|(3). -.RE +is overriden by \fBPedigree::PersonNode\fR\|(3) and \fBPedigree::AbortionNode\fR\|(3). .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" The calling program should define \fB\f(CB$main::DEBUG\fB\fR and set it to 0 or 1. .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fIpedigree\fR\|(1), \fIPedigree\fR\|(3) +\&\fBpedigree\fR\|(1), \fBPedigree\fR\|(3) .SH "AUTHOR" .IX Header "AUTHOR" Boris Veytsman, Leila Akhmadeeva, 2006, 2007 -.SH "POD ERRORS" -.IX Header "POD ERRORS" -Hey! \fBThe above document had some coding errors, which are explained below:\fR -.IP "Around line 80:" 4 -.IX Item "Around line 80:" -You can't have =items (as at line 136) unless the first thing after the =over is an =item |