---

vtkClipPlane Class Reference

SImple version. More...

#include <vtkClipPlane.h>

Inheritance diagram for vtkClipPlane:

[legend]Collaboration diagram for vtkClipPlane:

[legend]List of all members.

Public Methods
void	PrintSelf (ostream &os, vtkIndent indent)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	SetOrigin (float, float, float)
virtual void	SetOrigin (float[3])
virtual float *	GetOrigin ()
virtual void	GetOrigin (float &, float &, float &)
virtual void	GetOrigin (float[3])
virtual void	SetNormal (float, float, float)
virtual void	SetNormal (float[3])
virtual float *	GetNormal ()
virtual void	GetNormal (float &, float &, float &)
virtual void	GetNormal (float[3])
virtual void	SetOffset (float)
virtual float	GetOffset ()
Static Public Methods
int	IsTypeOf (const char *type)
vtkClipPlane *	SafeDownCast (vtkObject *o)
vtkClipPlane *	New ()
Protected Methods
	vtkClipPlane ()
	~vtkClipPlane ()
	vtkClipPlane (const vtkClipPlane &)
void	operator= (const vtkClipPlane &)
void	Execute ()
Protected Attributes
float	Normal [3]
float	Origin [3]
float	Offset
vtkPlane *	PlaneFunction

---

Detailed Description

SImple version.

Date:

2001/10/31 16:36:11

Revision:

1.2

vtkClipPlane is a simple version of the super class. The need for this should go away once all attributes are put in field.

Definition at line 57 of file vtkClipPlane.h.

---

Constructor & Destructor Documentation

vtkClipPlane::vtkClipPlane (    )  [protected]

vtkClipPlane::~vtkClipPlane (    )  [protected]

vtkClipPlane::vtkClipPlane (  const vtkClipPlane &    )  [inline, protected]

Definition at line 81 of file vtkClipPlane.h.

---

Member Function Documentation

void vtkClipPlane::PrintSelf (  ostream &    os, vtkIndent    indent )  [virtual]

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 vtkClipDataSet.

virtual const char* vtkClipPlane::GetClassName (    )  [virtual]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkClipDataSet.

int vtkClipPlane::IsTypeOf (  const char *    type )  [static]

Return 1 if this class type 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 vtkClipDataSet.

virtual int vtkClipPlane::IsA (  const char *    type )  [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 vtkClipDataSet.

vtkClipPlane* vtkClipPlane::SafeDownCast (  vtkObject *    o )  [static]

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkClipDataSet.

vtkClipPlane* vtkClipPlane::New (    )  [static]

Construct with user-specified implicit function; InsideOut turned off; value set to 0.0; and generate clip scalars turned off. Reimplemented from vtkClipDataSet.

virtual void vtkClipPlane::SetOrigin (  float   , float   , float    )  [virtual]

Direct acces to the plane parameters

virtual void vtkClipPlane::SetOrigin (  float   [3] )  [virtual]

Direct acces to the plane parameters

virtual float* vtkClipPlane::GetOrigin (    )  [virtual]

Direct acces to the plane parameters

virtual void vtkClipPlane::GetOrigin (  float &   , float &   , float &    )  [virtual]

Direct acces to the plane parameters

virtual void vtkClipPlane::GetOrigin (  float   [3] )  [virtual]

Direct acces to the plane parameters

virtual void vtkClipPlane::SetNormal (  float   , float   , float    )  [virtual]

Direct acces to the plane parameters

virtual void vtkClipPlane::SetNormal (  float   [3] )  [virtual]

Direct acces to the plane parameters

virtual float* vtkClipPlane::GetNormal (    )  [virtual]

Direct acces to the plane parameters

virtual void vtkClipPlane::GetNormal (  float &   , float &   , float &    )  [virtual]

Direct acces to the plane parameters

virtual void vtkClipPlane::GetNormal (  float   [3] )  [virtual]

Direct acces to the plane parameters

virtual void vtkClipPlane::SetOffset (  float    )  [virtual]

Offset of the plane from the origin. Units are respect to normal.

virtual float vtkClipPlane::GetOffset (    )  [virtual]

Offset of the plane from the origin. Units are respect to normal.

void vtkClipPlane::operator= (  const vtkClipPlane &    )  [inline, protected]

Definition at line 82 of file vtkClipPlane.h.

void vtkClipPlane::Execute (    )  [protected, virtual]

This method is the old style execute method Reimplemented from vtkClipDataSet.

---

Member Data Documentation

float vtkClipPlane::Normal[3] [protected]

Definition at line 86 of file vtkClipPlane.h.

float vtkClipPlane::Origin[3] [protected]

Definition at line 87 of file vtkClipPlane.h.

float vtkClipPlane::Offset [protected]

Definition at line 88 of file vtkClipPlane.h.

vtkPlane* vtkClipPlane::PlaneFunction [protected]

Definition at line 90 of file vtkClipPlane.h.

---

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

• Parallel/vtkClipPlane.h

---