GeometryEntry is a cache data for cursors requiring coordinates. More...

#include <vtkHyperTreeGridGeometryEntry.h>

Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent)
	Display info about the entry.

	vtkHyperTreeGridGeometryEntry ()
	Constructor.

	vtkHyperTreeGridGeometryEntry (vtkHyperTreeGridGeometryEntry const &)=default

vtkHyperTreeGridGeometryEntry &	operator= (vtkHyperTreeGridGeometryEntry const &)=default

	vtkHyperTreeGridGeometryEntry (vtkIdType index, const double *origin)
	Constructor.

	~vtkHyperTreeGridGeometryEntry ()=default
	Destructor.

void	Dump (ostream &os)
	Dump information.

vtkHyperTree *	Initialize (vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
	Initialize cursor at root of given tree index in grid.

void	Initialize (vtkIdType index, const double *origin)
	Initialize cursor from explicit required data.

void	Copy (const vtkHyperTreeGridGeometryEntry *entry)
	Copy function.

vtkIdType	GetVertexId () const
	Return the index of the current vertex in the tree.

vtkIdType	GetGlobalNodeIndex (const vtkHyperTree *tree) const
	Return the global index (relative to the grid) of the current vertex in the tree.

void	SetGlobalIndexStart (vtkHyperTree *tree, vtkIdType index)
	Set the global index for the root cell of the HyperTree.

void	SetGlobalIndexFromLocal (vtkHyperTree *tree, vtkIdType index)
	Set the global index for the current cell of the HyperTree.

void	SetMask (const vtkHyperTreeGrid grid, const vtkHyperTree tree, bool state)
	Set the blanking mask is empty or not.

bool	IsMasked (const vtkHyperTreeGrid grid, const vtkHyperTree tree) const
	Determine whether blanking mask is empty or not.

bool	IsLeaf (const vtkHyperTreeGrid grid, const vtkHyperTree tree, unsigned int level) const
	Is the cursor pointing to a leaf?

void	SubdivideLeaf (const vtkHyperTreeGrid grid, vtkHyperTree tree, unsigned int level)
	Change the current cell's status: if leaf then becomes coarse and all its children are created, cf.

bool	IsTerminalNode (const vtkHyperTreeGrid grid, const vtkHyperTree tree, unsigned int level) const
	Is the cursor pointing to a coarse with all children leaves ?

bool	IsRoot () const
	Is the cursor at tree root?

void	ToChild (const vtkHyperTreeGrid grid, const vtkHyperTree tree, unsigned int level, const double *sizeChild, unsigned char ichild)
	Move the cursor to child ‘child’ of the current vertex.

double *	GetOrigin ()
	Getter for origin coordinates of the current cell.

const double *	GetOrigin () const

void	GetBounds (const double *sizeChild, double bounds[6]) const
	Getter for bounding box of the current cell.

void	GetPoint (const double *sizeChild, double point[3]) const
	Getter for center of the current cell.

Detailed Description

GeometryEntry is a cache data for cursors requiring coordinates.

cf. vtkHyperTreeGridEntry

See also: vtkHyperTreeGridEntry vtkHyperTreeGridLevelEntry vtkHyperTreeGridGeometryEntry vtkHyperTreeGridGeometryLevelEntry vtkHyperTreeGridNonOrientedGeometryCursor vtkHyperTreeGridNonOrientedSuperCursor vtkHyperTreeGridNonOrientedSuperCursorLight

Thanks:: This class was written by Jacques-Bernard Lekien, Jerome Dubois and Guenole Harel, CEA 2018. This work was supported by Commissariat a l'Energie Atomique CEA, DAM, DIF, F-91297 Arpajon, France.

Definition at line 34 of file vtkHyperTreeGridGeometryEntry.h.

Constructor & Destructor Documentation

◆ vtkHyperTreeGridGeometryEntry() [1/3]

vtkHyperTreeGridGeometryEntry::vtkHyperTreeGridGeometryEntry ( )

Constructor.

◆ vtkHyperTreeGridGeometryEntry() [2/3]

vtkHyperTreeGridGeometryEntry::vtkHyperTreeGridGeometryEntry ( vtkHyperTreeGridGeometryEntry const & )

default

◆ vtkHyperTreeGridGeometryEntry() [3/3]

vtkHyperTreeGridGeometryEntry::vtkHyperTreeGridGeometryEntry	(	vtkIdType	index,
		const double *	origin
	)

inline

Constructor.

Definition at line 53 of file vtkHyperTreeGridGeometryEntry.h.

◆ ~vtkHyperTreeGridGeometryEntry()

vtkHyperTreeGridGeometryEntry::~vtkHyperTreeGridGeometryEntry ( )

default

Destructor.

Member Function Documentation

◆ PrintSelf()

void vtkHyperTreeGridGeometryEntry::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

Display info about the entry.

◆ operator=()

vtkHyperTreeGridGeometryEntry & vtkHyperTreeGridGeometryEntry::operator= ( vtkHyperTreeGridGeometryEntry const & )

default

◆ Dump()

void vtkHyperTreeGridGeometryEntry::Dump ( ostream & os )

Dump information.

◆ Initialize() [1/2]

vtkHyperTree * vtkHyperTreeGridGeometryEntry::Initialize	(	vtkHyperTreeGrid *	grid,
		vtkIdType	treeIndex,
		bool	create = `false`
	)

Initialize cursor at root of given tree index in grid.

◆ Initialize() [2/2]

void vtkHyperTreeGridGeometryEntry::Initialize	(	vtkIdType	index,
		const double *	origin
	)

inline

Initialize cursor from explicit required data.

Definition at line 80 of file vtkHyperTreeGridGeometryEntry.h.

◆ Copy()

void vtkHyperTreeGridGeometryEntry::Copy ( const vtkHyperTreeGridGeometryEntry * entry )

inline

Copy function.

Definition at line 92 of file vtkHyperTreeGridGeometryEntry.h.

◆ GetVertexId()

vtkIdType vtkHyperTreeGridGeometryEntry::GetVertexId ( ) const

inline

Return the index of the current vertex in the tree.

Definition at line 104 of file vtkHyperTreeGridGeometryEntry.h.

◆ GetGlobalNodeIndex()

vtkIdType vtkHyperTreeGridGeometryEntry::GetGlobalNodeIndex ( const vtkHyperTree * tree ) const

Return the global index (relative to the grid) of the current vertex in the tree.

Precondition: not_tree: tree

◆ SetGlobalIndexStart()

void vtkHyperTreeGridGeometryEntry::SetGlobalIndexStart	(	vtkHyperTree *	tree,
		vtkIdType	index
	)

Set the global index for the root cell of the HyperTree.

Precondition: not_tree: tree

◆ SetGlobalIndexFromLocal()

void vtkHyperTreeGridGeometryEntry::SetGlobalIndexFromLocal	(	vtkHyperTree *	tree,
		vtkIdType	index
	)

Set the global index for the current cell of the HyperTree.

Precondition: not_tree: tree

◆ SetMask()

void vtkHyperTreeGridGeometryEntry::SetMask	(	const vtkHyperTreeGrid *	grid,
		const vtkHyperTree *	tree,
		bool	state
	)

Set the blanking mask is empty or not.

Precondition: not_tree: tree

◆ IsMasked()

bool vtkHyperTreeGridGeometryEntry::IsMasked	(	const vtkHyperTreeGrid *	grid,
		const vtkHyperTree *	tree
	)		const

Determine whether blanking mask is empty or not.

Precondition: not_tree: tree

◆ IsLeaf()

bool vtkHyperTreeGridGeometryEntry::IsLeaf	(	const vtkHyperTreeGrid *	grid,
		const vtkHyperTree *	tree,
		unsigned int	level
	)		const

Is the cursor pointing to a leaf?

Precondition: not_tree: tree Return true if level == grid->GetDepthLimiter()

◆ SubdivideLeaf()

void vtkHyperTreeGridGeometryEntry::SubdivideLeaf	(	const vtkHyperTreeGrid *	grid,
		vtkHyperTree *	tree,
		unsigned int	level
	)

Change the current cell's status: if leaf then becomes coarse and all its children are created, cf.

HyperTree.

Precondition: not_tree: tree; depth_limiter: level == grid->GetDepthLimiter(); is_masked: IsMasked

◆ IsTerminalNode()

bool vtkHyperTreeGridGeometryEntry::IsTerminalNode	(	const vtkHyperTreeGrid *	grid,
		const vtkHyperTree *	tree,
		unsigned int	level
	)		const

Is the cursor pointing to a coarse with all children leaves ?

Precondition: not_tree: tree

◆ IsRoot()

bool vtkHyperTreeGridGeometryEntry::IsRoot ( ) const

inline

Is the cursor at tree root?

Definition at line 163 of file vtkHyperTreeGridGeometryEntry.h.

◆ ToChild()

void vtkHyperTreeGridGeometryEntry::ToChild	(	const vtkHyperTreeGrid *	grid,
		const vtkHyperTree *	tree,
		unsigned int	level,
		const double *	sizeChild,
		unsigned char	ichild
	)

Move the cursor to child ‘child’ of the current vertex.

Precondition: not_tree: tree; not_leaf: !IsLeaf(); valid_child: ichild>=0 && ichild<this->GetNumberOfChildren(); depth_limiter: level == grid->GetDepthLimiter(); is_masked: !IsMasked()

◆ GetOrigin() [1/2]

double * vtkHyperTreeGridGeometryEntry::GetOrigin ( )

inline

Getter for origin coordinates of the current cell.

Definition at line 179 of file vtkHyperTreeGridGeometryEntry.h.

◆ GetOrigin() [2/2]

const double * vtkHyperTreeGridGeometryEntry::GetOrigin ( ) const

inline

Definition at line 180 of file vtkHyperTreeGridGeometryEntry.h.

◆ GetBounds()

void vtkHyperTreeGridGeometryEntry::GetBounds	(	const double *	sizeChild,
		double	bounds[6]
	)		const

inline

Getter for bounding box of the current cell.

Definition at line 185 of file vtkHyperTreeGridGeometryEntry.h.

◆ GetPoint()

void vtkHyperTreeGridGeometryEntry::GetPoint	(	const double *	sizeChild,
		double	point[3]
	)		const

inline

Getter for center of the current cell.

Definition at line 199 of file vtkHyperTreeGridGeometryEntry.h.

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

Common/DataModel/vtkHyperTreeGridGeometryEntry.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ vtkHyperTreeGridGeometryEntry() [1/3]

◆ vtkHyperTreeGridGeometryEntry() [2/3]

◆ vtkHyperTreeGridGeometryEntry() [3/3]

◆ ~vtkHyperTreeGridGeometryEntry()

Member Function Documentation

◆ PrintSelf()

◆ operator=()

◆ Dump()

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ Copy()

◆ GetVertexId()

◆ GetGlobalNodeIndex()

◆ SetGlobalIndexStart()

◆ SetGlobalIndexFromLocal()

◆ SetMask()

◆ IsMasked()

◆ IsLeaf()

◆ SubdivideLeaf()

◆ IsTerminalNode()

◆ IsRoot()

◆ ToChild()

◆ GetOrigin() [1/2]

◆ GetOrigin() [2/2]

◆ GetBounds()

◆ GetPoint()