dialect::FaceSet Class Reference

#include <faces.h>

Collaboration diagram for dialect::FaceSet:

Public Member Functions
size_t	getNumFaces (void)
	Check how many faces there are.
TreePlacements	listAllPossibleTreePlacements (Tree_SP tree, dialect::HolaOpts opts)
	Compute all the possible ways of placing a given Tree into the Faces, given that it must connect at a particular root node in the underlying Graph. More...
TreePlacements	getAllTreePlacements (void)
	After tree placements have actually been chosen and performed (i.e. trees have been placed into faces), obtain a vector of all those TreePlacements that were actually chosen.
Faces	getFaces (void)
	Get a copy of the vector of Faces_SP's.
Face_SP	getExternalFace (void)
	Get the external Face.
std::map< CardinalDir, size_t >	getNumTreesByGrowthDir (bool scaleBySize=false) const
	After tree placements have been chosen and performed, get a count of trees by growth direction. More...

Detailed Description

Holds all the Face objects for a given 4-planar, orthogonal layout, and provides methods to use and manage them.

Member Function Documentation

getNumTreesByGrowthDir()

std::map< CardinalDir, size_t > FaceSet::getNumTreesByGrowthDir

(

bool

scaleBySize = false

)

const

After tree placements have been chosen and performed, get a count of trees by growth direction.

Parameters

[in]

scaleBySize

Set true if for each tree you actually want to count its number of nodes. In other words, the final counts you get actually indicate the number of nodes in trees that grow in the given directions.

listAllPossibleTreePlacements()

TreePlacements FaceSet::listAllPossibleTreePlacements	(	Tree_SP	tree,
		dialect::HolaOpts	opts
	)

Compute all the possible ways of placing a given Tree into the Faces, given that it must connect at a particular root node in the underlying Graph.

Parameters

[in]	tree	The Tree to be placed.
[in]	opts	Options to control which kinds of placements are defined. See method of the same name in the Face class.

See also

Face::listAllPossibleTreePlacements.

References vpsc::XDIM, and vpsc::YDIM.

---

The documentation for this class was generated from the following files:

• libdialect/faces.h
• libdialect/faces.cpp