vtkPlaneSource Class Reference

create an array of quadrilaterals located in a plane More...

#include <vtkPlaneSource.h>

Inheritance diagram for vtkPlaneSource:

Collaboration diagram for vtkPlaneSource:

Public Types
typedef vtkPolyDataAlgorithm	Superclass
Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass

Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkPlaneSource *	NewInstance () const
virtual void	SetXResolution (int)
	Specify the resolution of the plane along the first axes. More...
virtual int	GetXResolution ()
virtual void	SetYResolution (int)
	Specify the resolution of the plane along the second axes. More...
virtual int	GetYResolution ()
void	SetResolution (const int xR, const int yR)
	Set the number of x-y subdivisions in the plane. More...
void	GetResolution (int &xR, int &yR)
virtual void	SetOrigin (double, double, double)
	Specify a point defining the origin of the plane. More...
virtual void	SetOrigin (double[3])
virtual double *	GetOrigin ()
virtual void	GetOrigin (double data[3])
void	SetPoint1 (double x, double y, double z)
	Specify a point defining the first axis of the plane. More...
void	SetPoint1 (double pnt[3])
virtual double *	GetPoint1 ()
virtual void	GetPoint1 (double data[3])
void	SetPoint2 (double x, double y, double z)
	Specify a point defining the second axis of the plane. More...
void	SetPoint2 (double pnt[3])
virtual double *	GetPoint2 ()
virtual void	GetPoint2 (double data[3])
void	GetAxis1 (double a1[3])
	Convenience methods to retrieve the axes of the plane; that is axis a1 is the vector (Point1-Origin), and axis a2 is the vector (Point2-Origin). More...
void	GetAxis2 (double a2[3])
void	SetCenter (double x, double y, double z)
	Set/Get the center of the plane. More...
void	SetCenter (double center[3])
virtual double *	GetCenter ()
virtual void	GetCenter (double data[3])
void	SetNormal (double nx, double ny, double nz)
	Set/Get the plane normal. More...
void	SetNormal (double n[3])
virtual double *	GetNormal ()
virtual void	GetNormal (double data[3])
void	Push (double distance)
	Translate the plane in the direction of the normal by the distance specified. More...
virtual void	SetOutputPointsPrecision (int)
	Set/get the desired precision for the output points. More...
virtual int	GetOutputPointsPrecision ()
Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithm *	NewInstance () const
vtkPolyData *	GetOutput ()
	Get the output data object for a port on this algorithm. More...
vtkPolyData *	GetOutput (int)
virtual void	SetOutput (vtkDataObject *d)
vtkTypeBool	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	see vtkAlgorithm for details More...
vtkDataObject *	GetInput ()
vtkDataObject *	GetInput (int port)
vtkPolyData *	GetPolyDataInput (int port)
void	SetInputData (vtkDataObject *)
	Assign a data object as input. More...
void	SetInputData (int, vtkDataObject *)
void	AddInputData (vtkDataObject *)
	Assign a data object as input. More...
void	AddInputData (int, vtkDataObject *)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped. More...
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...
virtual void	SetInformation (vtkInformation *)
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm. More...
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm. More...
void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...
void	UnRegister (vtkObjectBase *o) override
	Decrease the reference count (release by another object). More...
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object. More...
virtual vtkTypeBool	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual double	GetProgress ()
	Get the execution progress of a process object. More...
void	SetProgress (double)
	SetProgress is deprecated. More...
void	UpdateProgress (double amount)
	Update the progress of the process object. More...
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
virtual double	GetProgressShift ()
virtual double	GetProgressScale ()
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file. More...
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process. More...
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
	String based versions of SetInputArrayToProcess(). More...
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...
void	RemoveAllInputs ()
	Remove all the input data. More...
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index. More...
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx. More...
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections. More...
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index. More...
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port. More...
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port. More...
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm. More...
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...
virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...
virtual void	Update ()
virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port. More...
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...
virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port. More...
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...
virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date. More...
virtual void	UpdateDataObject ()
	Create output object(s). More...
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream. More...
virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date. More...
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on. More...
virtual void	DebugOff ()
	Turn debugging output off. More...
bool	GetDebug ()
	Get the value of the debug flag. More...
void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...
virtual void	Modified ()
	Update the modification time for this object. More...
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
virtual void	Delete ()
	Delete a VTK object. More...
virtual void	FastDelete ()
	Delete a reference to this object. More...
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream. More...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
	Return the current reference count of this object. More...
void	SetReferenceCount (int)
	Sets the reference count. More...
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPlaneSource *	SafeDownCast (vtkObjectBase *o)
static vtkPlaneSource *	New ()
	Construct plane perpendicular to z-axis, resolution 1x1, width and height 1.0, and centered at the origin. More...
Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPlaneSource ()
	~vtkPlaneSource () override=default
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called by the superclass. More...
int	UpdatePlane (double v1[3], double v2[3])
Protected Member Functions inherited from vtkPolyDataAlgorithm
	vtkPolyDataAlgorithm ()
	~vtkPolyDataAlgorithm () override
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called by the superclass. More...
int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm. More...
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm. More...
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm () override
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm. More...
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm. More...
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive. More...
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. More...
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port. More...
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port. More...
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input. More...
void	AddInputDataInternal (int port, vtkDataObject *input)
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	XResolution
int	YResolution
double	Origin [3]
double	Point1 [3]
double	Point2 [3]
double	Normal [3]
double	Center [3]
int	OutputPointsPrecision
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
unsigned long	ErrorCode
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

create an array of quadrilaterals located in a plane

vtkPlaneSource creates an m x n array of quadrilaterals arranged as a regular tiling in a plane. The plane is defined by specifying an origin point, and then two other points that, together with the origin, define two axes for the plane. These axes do not have to be orthogonal - so you can create a parallelogram. (The axes must not be parallel.) The resolution of the plane (i.e., number of subdivisions) is controlled by the ivars XResolution and YResolution.

By default, the plane is centered at the origin and perpendicular to the z-axis, with width and height of length 1 and resolutions set to 1.

There are three convenience methods that allow you to easily move the plane. The first, SetNormal(), allows you to specify the plane normal. The effect of this method is to rotate the plane around the center of the plane, aligning the plane normal with the specified normal. The rotation is about the axis defined by the cross product of the current normal with the new normal. The second, SetCenter(), translates the center of the plane to the specified center point. The third method, Push(), allows you to translate the plane along the plane normal by the distance specified. (Negative Push values translate the plane in the negative normal direction.) Note that the SetNormal(), SetCenter() and Push() methods modify the Origin, Point1, and/or Point2 instance variables.

Warning

The normal to the plane will point in the direction of the cross product of the first axis (Origin->Point1) with the second (Origin->Point2). This also affects the normals to the generated polygons.

Definition at line 54 of file vtkPlaneSource.h.

Member Typedef Documentation

Superclass

typedef vtkPolyDataAlgorithm vtkPlaneSource::Superclass

Definition at line 58 of file vtkPlaneSource.h.

Constructor & Destructor Documentation

vtkPlaneSource()

vtkPlaneSource::vtkPlaneSource ( )

protected

~vtkPlaneSource()

vtkPlaneSource::~vtkPlaneSource ( )

overrideprotecteddefault

Member Function Documentation

PrintSelf()

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

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

IsTypeOf()

static vtkTypeBool vtkPlaneSource::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkPlaneSource::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

SafeDownCast()

static vtkPlaneSource* vtkPlaneSource::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase* vtkPlaneSource::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

NewInstance()

vtkPlaneSource* vtkPlaneSource::NewInstance

(

)

const

New()

static vtkPlaneSource* vtkPlaneSource::New ( )

static

Construct plane perpendicular to z-axis, resolution 1x1, width and height 1.0, and centered at the origin.

SetXResolution()

virtual void vtkPlaneSource::SetXResolution ( int  )

virtual

Specify the resolution of the plane along the first axes.

GetXResolution()

virtual int vtkPlaneSource::GetXResolution ( )

virtual

SetYResolution()

virtual void vtkPlaneSource::SetYResolution ( int  )

virtual

Specify the resolution of the plane along the second axes.

GetYResolution()

virtual int vtkPlaneSource::GetYResolution ( )

virtual

SetResolution()

void vtkPlaneSource::SetResolution	(	const int	xR,
		const int	yR
	)

Set the number of x-y subdivisions in the plane.

GetResolution()

void vtkPlaneSource::GetResolution ( int &  xR, int &  yR  )

inline

Definition at line 87 of file vtkPlaneSource.h.

SetOrigin() [1/2]

virtual void vtkPlaneSource::SetOrigin ( double  , double  , double    )

virtual

Specify a point defining the origin of the plane.

SetOrigin() [2/2]

virtual void vtkPlaneSource::SetOrigin ( double  [3] )

virtual

GetOrigin() [1/2]

virtual double* vtkPlaneSource::GetOrigin ( )

virtual

GetOrigin() [2/2]

virtual void vtkPlaneSource::GetOrigin ( double  data[3] )

virtual

SetPoint1() [1/2]

void vtkPlaneSource::SetPoint1	(	double	x,
		double	y,
		double	z
	)

Specify a point defining the first axis of the plane.

SetPoint1() [2/2]

void vtkPlaneSource::SetPoint1

(

double

pnt[3]

)

GetPoint1() [1/2]

virtual double* vtkPlaneSource::GetPoint1 ( )

virtual

GetPoint1() [2/2]

virtual void vtkPlaneSource::GetPoint1 ( double  data[3] )

virtual

SetPoint2() [1/2]

void vtkPlaneSource::SetPoint2	(	double	x,
		double	y,
		double	z
	)

Specify a point defining the second axis of the plane.

SetPoint2() [2/2]

void vtkPlaneSource::SetPoint2

(

double

pnt[3]

)

GetPoint2() [1/2]

virtual double* vtkPlaneSource::GetPoint2 ( )

virtual

GetPoint2() [2/2]

virtual void vtkPlaneSource::GetPoint2 ( double  data[3] )

virtual

GetAxis1()

void vtkPlaneSource::GetAxis1

(

double

a1[3]

)

Convenience methods to retrieve the axes of the plane; that is axis a1 is the vector (Point1-Origin), and axis a2 is the vector (Point2-Origin).

GetAxis2()

void vtkPlaneSource::GetAxis2

(

double

a2[3]

)

SetCenter() [1/2]

void vtkPlaneSource::SetCenter	(	double	x,
		double	y,
		double	z
	)

Set/Get the center of the plane.

Works in conjunction with the plane normal to position the plane. Don't use this method to define the plane. Instead, use it to move the plane to a new center point.

SetCenter() [2/2]

void vtkPlaneSource::SetCenter

(

double

center[3]

)

GetCenter() [1/2]

virtual double* vtkPlaneSource::GetCenter ( )

virtual

GetCenter() [2/2]

virtual void vtkPlaneSource::GetCenter ( double  data[3] )

virtual

SetNormal() [1/2]

void vtkPlaneSource::SetNormal	(	double	nx,
		double	ny,
		double	nz
	)

Set/Get the plane normal.

Works in conjunction with the plane center to orient the plane. Don't use this method to define the plane. Instead, use it to rotate the plane around the current center point.

SetNormal() [2/2]

void vtkPlaneSource::SetNormal

(

double

n[3]

)

GetNormal() [1/2]

virtual double* vtkPlaneSource::GetNormal ( )

virtual

GetNormal() [2/2]

virtual void vtkPlaneSource::GetNormal ( double  data[3] )

virtual

Push()

void vtkPlaneSource::Push

(

double

distance

)

Translate the plane in the direction of the normal by the distance specified.

Negative values move the plane in the opposite direction.

SetOutputPointsPrecision()

virtual void vtkPlaneSource::SetOutputPointsPrecision ( int  )

virtual

Set/get the desired precision for the output points.

vtkAlgorithm::SINGLE_PRECISION - Output single-precision floating point. vtkAlgorithm::DOUBLE_PRECISION - Output double-precision floating point.

GetOutputPointsPrecision()

virtual int vtkPlaneSource::GetOutputPointsPrecision ( )

virtual

RequestData()

int vtkPlaneSource::RequestData ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

UpdatePlane()

int vtkPlaneSource::UpdatePlane ( double  v1[3], double  v2[3]  )

protected

Member Data Documentation

XResolution

int vtkPlaneSource::XResolution

protected

Definition at line 175 of file vtkPlaneSource.h.

YResolution

int vtkPlaneSource::YResolution

protected

Definition at line 176 of file vtkPlaneSource.h.

Origin

double vtkPlaneSource::Origin[3]

protected

Definition at line 177 of file vtkPlaneSource.h.

Point1

double vtkPlaneSource::Point1[3]

protected

Definition at line 178 of file vtkPlaneSource.h.

Point2

double vtkPlaneSource::Point2[3]

protected

Definition at line 179 of file vtkPlaneSource.h.

Normal

double vtkPlaneSource::Normal[3]

protected

Definition at line 180 of file vtkPlaneSource.h.

Center

double vtkPlaneSource::Center[3]

protected

Definition at line 181 of file vtkPlaneSource.h.

OutputPointsPrecision

int vtkPlaneSource::OutputPointsPrecision

protected

Definition at line 182 of file vtkPlaneSource.h.

---

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

• Filters/Sources/vtkPlaneSource.h