Kitware.VTK.vtkAreaLayout Class Reference

vtkAreaLayout - layout a vtkTree into a tree map More...

Inheritance diagram for Kitware.VTK.vtkAreaLayout:

Collaboration diagram for Kitware.VTK.vtkAreaLayout:

List of all members.

Public Member Functions
	vtkAreaLayout (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkAreaLayout ()
	Undocumented Block.
virtual void	EdgeRoutingPointsOff ()
	Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.
virtual void	EdgeRoutingPointsOn ()
	Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.
long	FindVertex (IntPtr pnt)
	Get the vertex whose area contains the point, or return -1 if no vertex area covers the point.
virtual string	GetAreaArrayName ()
	The name for the array created for the area for each vertex. The rectangles are stored in a quadruple float array (startAngle, endAngle, innerRadius, outerRadius). For rectangular layouts, this is (minx, maxx, miny, maxy).
void	GetBoundingArea (long id, IntPtr sinfo)
	The bounding area information for a certain vertex id.
virtual bool	GetEdgeRoutingPoints ()
	Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.
virtual vtkAreaLayoutStrategy	GetLayoutStrategy ()
	The strategy to use when laying out the tree map.
override uint	GetMTime ()
	Get the modification time of the layout algorithm.
override int	IsA (string type)
	Undocumented Block.
new vtkAreaLayout	NewInstance ()
	Undocumented Block.
virtual void	SetAreaArrayName (string _arg)
	The name for the array created for the area for each vertex. The rectangles are stored in a quadruple float array (startAngle, endAngle, innerRadius, outerRadius). For rectangular layouts, this is (minx, maxx, miny, maxy).
virtual void	SetEdgeRoutingPoints (bool _arg)
	Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.
void	SetLayoutStrategy (vtkAreaLayoutStrategy strategy)
	The strategy to use when laying out the tree map.
virtual void	SetSizeArrayName (string name)
	The array name to use for retrieving the relative size of each vertex. If this array is not found, use constant size for each vertex.
Static Public Member Functions
static new vtkAreaLayout	New ()
	Undocumented Block.
static new int	IsTypeOf (string type)
	Undocumented Block.
static new vtkAreaLayout	SafeDownCast (vtkObjectBase o)
	Undocumented Block.
Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkAreaLayout"
	Automatically generated type registration mechanics.
Static Public Attributes
static new readonly string	MRClassNameKey = "13vtkAreaLayout"
	Automatically generated type registration mechanics.
Protected Member Functions
override void	Dispose (bool disposing)
	Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.
Private Member Functions
static internal IntPtr	vtkAreaLayout_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void	vtkAreaLayout_EdgeRoutingPointsOff_01 (HandleRef pThis)
static internal void	vtkAreaLayout_EdgeRoutingPointsOn_02 (HandleRef pThis)
static internal long	vtkAreaLayout_FindVertex_03 (HandleRef pThis, IntPtr pnt)
static internal IntPtr	vtkAreaLayout_GetAreaArrayName_04 (HandleRef pThis)
static internal void	vtkAreaLayout_GetBoundingArea_05 (HandleRef pThis, long id, IntPtr sinfo)
static internal byte	vtkAreaLayout_GetEdgeRoutingPoints_06 (HandleRef pThis)
static internal IntPtr	vtkAreaLayout_GetLayoutStrategy_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal uint	vtkAreaLayout_GetMTime_08 (HandleRef pThis)
static internal int	vtkAreaLayout_IsA_09 (HandleRef pThis, string type)
static internal int	vtkAreaLayout_IsTypeOf_10 (string type)
static internal IntPtr	vtkAreaLayout_NewInstance_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr	vtkAreaLayout_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void	vtkAreaLayout_SetAreaArrayName_14 (HandleRef pThis, string _arg)
static internal void	vtkAreaLayout_SetEdgeRoutingPoints_15 (HandleRef pThis, byte _arg)
static internal void	vtkAreaLayout_SetLayoutStrategy_16 (HandleRef pThis, HandleRef strategy)
static internal void	vtkAreaLayout_SetSizeArrayName_17 (HandleRef pThis, string name)
Static Private Member Functions
static	vtkAreaLayout ()
	Automatically generated type registration mechanics.

---

Detailed Description

vtkAreaLayout - layout a vtkTree into a tree map

Description vtkAreaLayout assigns sector regions to each vertex in the tree, creating a tree ring. The data is added as a data array with four components per tuple representing the location and size of the sector using the format (StartAngle, EndAngle, innerRadius, outerRadius).

This algorithm relies on a helper class to perform the actual layout. This helper class is a subclass of vtkAreaLayoutStrategy.

Thanks Thanks to Jason Shepherd from Sandia National Laboratories for help developing this class.

---

Constructor & Destructor Documentation

static Kitware.VTK.vtkAreaLayout.vtkAreaLayout

(

)

[static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkAreaLayout.vtkAreaLayout	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkAreaLayout.vtkAreaLayout

(

)

Undocumented Block.

---

Member Function Documentation

override void Kitware.VTK.vtkAreaLayout.Dispose

(

bool

disposing

)

[protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

virtual void Kitware.VTK.vtkAreaLayout.EdgeRoutingPointsOff

(

)

[virtual]

Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.

virtual void Kitware.VTK.vtkAreaLayout.EdgeRoutingPointsOn

(

)

[virtual]

Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.

long Kitware.VTK.vtkAreaLayout.FindVertex

(

IntPtr

pnt

)

Get the vertex whose area contains the point, or return -1 if no vertex area covers the point.

virtual string Kitware.VTK.vtkAreaLayout.GetAreaArrayName

(

)

[virtual]

The name for the array created for the area for each vertex. The rectangles are stored in a quadruple float array (startAngle, endAngle, innerRadius, outerRadius). For rectangular layouts, this is (minx, maxx, miny, maxy).

void Kitware.VTK.vtkAreaLayout.GetBoundingArea	(	long	id,
		IntPtr	sinfo
	)

The bounding area information for a certain vertex id.

virtual bool Kitware.VTK.vtkAreaLayout.GetEdgeRoutingPoints

(

)

[virtual]

Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.

virtual vtkAreaLayoutStrategy Kitware.VTK.vtkAreaLayout.GetLayoutStrategy

(

)

[virtual]

The strategy to use when laying out the tree map.

Here is the call graph for this function:

override uint Kitware.VTK.vtkAreaLayout.GetMTime

(

)

[virtual]

Get the modification time of the layout algorithm.

Reimplemented from Kitware.VTK.vtkObject.

override int Kitware.VTK.vtkAreaLayout.IsA

(

string

type

)

[virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

static new int Kitware.VTK.vtkAreaLayout.IsTypeOf

(

string

type

)

[static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

static new vtkAreaLayout Kitware.VTK.vtkAreaLayout.New

(

)

[static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

new vtkAreaLayout Kitware.VTK.vtkAreaLayout.NewInstance

(

)

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

static new vtkAreaLayout Kitware.VTK.vtkAreaLayout.SafeDownCast

(

vtkObjectBase

o

)

[static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkAreaLayout.SetAreaArrayName

(

string

_arg

)

[virtual]

The name for the array created for the area for each vertex. The rectangles are stored in a quadruple float array (startAngle, endAngle, innerRadius, outerRadius). For rectangular layouts, this is (minx, maxx, miny, maxy).

virtual void Kitware.VTK.vtkAreaLayout.SetEdgeRoutingPoints

(

bool

_arg

)

[virtual]

Whether to output a second output tree with vertex locations appropriate for routing bundled edges. Default is on.

void Kitware.VTK.vtkAreaLayout.SetLayoutStrategy

(

vtkAreaLayoutStrategy

strategy

)

The strategy to use when laying out the tree map.

virtual void Kitware.VTK.vtkAreaLayout.SetSizeArrayName

(

string

name

)

[virtual]

The array name to use for retrieving the relative size of each vertex. If this array is not found, use constant size for each vertex.

static internal void Kitware.VTK.vtkAreaLayout.vtkAreaLayout_EdgeRoutingPointsOff_01

(

HandleRef

pThis

)

[private]

static internal void Kitware.VTK.vtkAreaLayout.vtkAreaLayout_EdgeRoutingPointsOn_02

(

HandleRef

pThis

)

[private]

static internal long Kitware.VTK.vtkAreaLayout.vtkAreaLayout_FindVertex_03	(	HandleRef	pThis,
		IntPtr	pnt
	)		[private]

static internal IntPtr Kitware.VTK.vtkAreaLayout.vtkAreaLayout_GetAreaArrayName_04

(

HandleRef

pThis

)

[private]

static internal void Kitware.VTK.vtkAreaLayout.vtkAreaLayout_GetBoundingArea_05	(	HandleRef	pThis,
		long	id,
		IntPtr	sinfo
	)		[private]

static internal byte Kitware.VTK.vtkAreaLayout.vtkAreaLayout_GetEdgeRoutingPoints_06

(

HandleRef

pThis

)

[private]

static internal IntPtr Kitware.VTK.vtkAreaLayout.vtkAreaLayout_GetLayoutStrategy_07	(	HandleRef	pThis,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal uint Kitware.VTK.vtkAreaLayout.vtkAreaLayout_GetMTime_08

(

HandleRef

pThis

)

[private]

static internal int Kitware.VTK.vtkAreaLayout.vtkAreaLayout_IsA_09	(	HandleRef	pThis,
		string	type
	)		[private]

static internal int Kitware.VTK.vtkAreaLayout.vtkAreaLayout_IsTypeOf_10

(

string

type

)

[private]

static internal IntPtr Kitware.VTK.vtkAreaLayout.vtkAreaLayout_New	(	ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal IntPtr Kitware.VTK.vtkAreaLayout.vtkAreaLayout_NewInstance_12	(	HandleRef	pThis,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal IntPtr Kitware.VTK.vtkAreaLayout.vtkAreaLayout_SafeDownCast_13	(	HandleRef	o,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal void Kitware.VTK.vtkAreaLayout.vtkAreaLayout_SetAreaArrayName_14	(	HandleRef	pThis,
		string	_arg
	)		[private]

static internal void Kitware.VTK.vtkAreaLayout.vtkAreaLayout_SetEdgeRoutingPoints_15	(	HandleRef	pThis,
		byte	_arg
	)		[private]

static internal void Kitware.VTK.vtkAreaLayout.vtkAreaLayout_SetLayoutStrategy_16	(	HandleRef	pThis,
		HandleRef	strategy
	)		[private]

static internal void Kitware.VTK.vtkAreaLayout.vtkAreaLayout_SetSizeArrayName_17	(	HandleRef	pThis,
		string	name
	)		[private]

---

Member Data Documentation

new readonly string Kitware.VTK.vtkAreaLayout.MRClassNameKey = "13vtkAreaLayout" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

new const string Kitware.VTK.vtkAreaLayout.MRFullTypeName = "Kitware.VTK.vtkAreaLayout"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkTreeAlgorithm.

---

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

• csharp/vtkAreaLayout.cs