ssDepthSortPolyData Class Reference
[Simulator/Common/C++]

ssDepthSortPolyData - sort poly data along camera view direction. More...

#include <ssDepthSortPolyData.h>

Inheritance diagram for ssDepthSortPolyData:

Inheritance graph
[legend]
Collaboration diagram for ssDepthSortPolyData:

Collaboration graph
[legend]
List of all members.

Public Types

enum  SortMethod { SS_DIRECTION_BACK_TO_FRONT = 0, SS_DIRECTION_FRONT_TO_BACK, SS_DIRECTION_SPECIFIED_VECTOR }
 Sort method. More...

Public Member Functions

 vtkTypeMacro (ssDepthSortPolyData, vtkPolyDataToPolyDataFilter)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetDirection (int arg)
 Specify the sort method for the polygonal primitives.
virtual int GetDirection () const
 Give the sort method for the polygonal primitives.
void SetDirectionToFrontToBack ()
 Set the sort direction to front to back.
void SetDirectionToBackToFront ()
 Set the sort direction to back to front.
void SetDirectionToSpecifiedVector ()
 Set the sort direction to specified vector.
virtual void SetCamera (vtkCamera *arg)
 Specify a camera that is used to define a view direction along which the cells are sorted.
virtual vtkCameraGetCamera () const
 Give the camera in use.
void SetProp3D (vtkProp3D *arg)
 Specify a transformation matrix (via the vtkProp3D::GetMatrix() method) that is used to include the effects of transformation.
vtkProp3DGetProp3D ()
virtual void SetVector (double x, double y, double z)
 Specify the sort direction.
virtual void SetVector (double x[3])
 Specify the sort direction.
virtual const double * GetVector () const
 Give the sort direction.
virtual void GetVector (double x[3])
 Give the sort direction.
virtual void SetOrigin (double x, double y, double z)
 Specify the sort origin.
virtual void SetOrigin (double x[3])
 Set/Get the sort origin.
virtual const double * GetOrigin () const
 Give the sort orgin in use.
virtual void GetOrigin (double x[3])
 Give the sort origin in use.
virtual void SetSortScalars (int arg)
 Specify a flag that controls the generation of scalar values corresponding to the sort order.
virtual int GetSortScalars ()
 Give the flag that controls generation of the scalar values corresponding to the sort order.
virtual void SortScalarsOn ()
 Specify the sorting of scalars.
virtual void SortScalarsOff ()
 Specify no sorting of scalars.
unsigned long GetMTime ()
 Return MTime also considering the dependent objects: the camera and/or the prop3D.

Static Public Member Functions

static ssDepthSortPolyDataNew ()
 Instantiate object.

Protected Member Functions

 ssDepthSortPolyData ()
 ~ssDepthSortPolyData ()
 ssDepthSortPolyData (const ssDepthSortPolyData &)
void operator= (const ssDepthSortPolyData &)
void Execute ()
 Execute the algorithm,.
void ComputeProjectionVector (double vector[3], double origin[3])
 Give a vector from the camera to the focal point.

Protected Attributes

int Direction
vtkCameraCamera
vtkProp3DProp3D
vtkTransformTransform
double Vector [3]
double Origin [3]
int SortScalars

Detailed Description

ssDepthSortPolyData - sort poly data along camera view direction.

ssDepthSortPolyData rearranges the order of cells so that certain rendering operations (e.g., transparency or Painter's algorithms) generate correct results. To use this filter you must specify the direction vector along which to sort the cells. You can do this by specifying a camera and/or prop to define a view direction; or explicitly set a view direction.

Definition at line 76 of file ssDepthSortPolyData.h.


Member Enumeration Documentation

enum ssDepthSortPolyData::SortMethod

Sort method.

Enumerator:
SS_DIRECTION_BACK_TO_FRONT 
SS_DIRECTION_FRONT_TO_BACK 
SS_DIRECTION_SPECIFIED_VECTOR 

Definition at line 82 of file ssDepthSortPolyData.h.


Constructor & Destructor Documentation

ssDepthSortPolyData::ssDepthSortPolyData (  )  [protected]

ssDepthSortPolyData::~ssDepthSortPolyData (  )  [protected]

ssDepthSortPolyData::ssDepthSortPolyData ( const ssDepthSortPolyData  )  [inline, protected]

Definition at line 318 of file ssDepthSortPolyData.h.


Member Function Documentation

static ssDepthSortPolyData* ssDepthSortPolyData::New (  )  [static]

Instantiate object.

Returns:
A new instance of this class.

Reimplemented from vtkAlgorithm.

ssDepthSortPolyData::vtkTypeMacro ( ssDepthSortPolyData  ,
vtkPolyDataToPolyDataFilter   
)

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

Reimplemented from vtkPolyDataToPolyDataFilter.

virtual void ssDepthSortPolyData::SetDirection ( int  arg  )  [inline, virtual]

Specify the sort method for the polygonal primitives.

Parameters:
arg The sort method. Valid arguments are SS_DIRECTION_FRONT_TO_BACK, SS_DIRECTION_BACK_TO_FRONT or SS_DIRECTION_SPECIFIED_VECTOR.

Definition at line 103 of file ssDepthSortPolyData.h.

virtual int ssDepthSortPolyData::GetDirection (  )  const [inline, virtual]

Give the sort method for the polygonal primitives.

Returns:
The sort method. Valid returns are SS_DIRECTION_FRONT_TO_BACK, SS_DIRECTION_FRONT_TO_BACK, SS_DIRECTION_BACK_TO_FRONT or SS_DIRECTION_SPECIFIED_VECTOR.

Definition at line 114 of file ssDepthSortPolyData.h.

void ssDepthSortPolyData::SetDirectionToFrontToBack (  )  [inline]

Set the sort direction to front to back.

Definition at line 122 of file ssDepthSortPolyData.h.

void ssDepthSortPolyData::SetDirectionToBackToFront (  )  [inline]

Set the sort direction to back to front.

Definition at line 130 of file ssDepthSortPolyData.h.

void ssDepthSortPolyData::SetDirectionToSpecifiedVector (  )  [inline]

Set the sort direction to specified vector.

Definition at line 138 of file ssDepthSortPolyData.h.

virtual void ssDepthSortPolyData::SetCamera ( vtkCamera arg  )  [inline, virtual]

Specify a camera that is used to define a view direction along which the cells are sorted.

This ivar only has effect if the direction is set to front-to-back or back-to-front, and a camera is specified. arg The Camera.

Definition at line 149 of file ssDepthSortPolyData.h.

virtual vtkCamera* ssDepthSortPolyData::GetCamera (  )  const [inline, virtual]

Give the camera in use.

Returns:
The camera.

Definition at line 158 of file ssDepthSortPolyData.h.

void ssDepthSortPolyData::SetProp3D ( vtkProp3D arg  ) 

Specify a transformation matrix (via the vtkProp3D::GetMatrix() method) that is used to include the effects of transformation.

This ivar only has effect if the direction is set to front-to-back or back-to-front, and a camera is specified. Specifying the vtkProp3D is optional.

Parameters:
arg The property.

vtkProp3D* ssDepthSortPolyData::GetProp3D (  ) 

virtual void ssDepthSortPolyData::SetVector ( double  x,
double  y,
double  z 
) [inline, virtual]

Specify the sort direction.

This ivar only has effect if the sort direction is set to SetDirectionToSpecifiedVector(). The sort occurs in the direction of the vector.

Parameters:
x The value of the vector in the x domain.
y The value of the vector in the y domain.
z The value of the vector in the z domain.

Definition at line 181 of file ssDepthSortPolyData.h.

virtual void ssDepthSortPolyData::SetVector ( double  x[3]  )  [inline, virtual]

Specify the sort direction.

This ivar only has effect if the sort direction is set to SetDirectionToSpecifiedVector(). The sort occurs in the direction of the vector.

Parameters:
x The value of the vector as a x, y, z tuple.

Definition at line 194 of file ssDepthSortPolyData.h.

virtual const double* ssDepthSortPolyData::GetVector (  )  const [inline, virtual]

Give the sort direction.

Returns:
The vector as an x, y, z tuple.

Definition at line 205 of file ssDepthSortPolyData.h.

virtual void ssDepthSortPolyData::GetVector ( double  x[3]  )  [inline, virtual]

Give the sort direction.

Parameters:
x The vector to be returned as an x, y, z tuple.

Definition at line 214 of file ssDepthSortPolyData.h.

virtual void ssDepthSortPolyData::SetOrigin ( double  x,
double  y,
double  z 
) [inline, virtual]

Specify the sort origin.

This ivar only has effect if the sort direction is set to SetDirectionToSpecifiedVector(). The sort occurs in the direction of the vector, with this point specifying the origin.

Parameters:
x The value of the origin in the x domain.
y The value of the origin in the y domain.
z The value of the origin in the z domain.

Definition at line 230 of file ssDepthSortPolyData.h.

virtual void ssDepthSortPolyData::SetOrigin ( double  x[3]  )  [inline, virtual]

Set/Get the sort origin.

This ivar only has effect if the sort direction is set to SetDirectionToSpecifiedVector(). The sort occurs in the direction of the vector, with this point specifying the origin.

Parameters:
x The value of the origin as a x, y, z tuple.

Definition at line 244 of file ssDepthSortPolyData.h.

virtual const double* ssDepthSortPolyData::GetOrigin (  )  const [inline, virtual]

Give the sort orgin in use.

Returns:
The origin as a x, y, z tuple.

Definition at line 255 of file ssDepthSortPolyData.h.

virtual void ssDepthSortPolyData::GetOrigin ( double  x[3]  )  [inline, virtual]

Give the sort origin in use.

Parameters:
x The vector to be returned as a x, y, y tuple.

Definition at line 264 of file ssDepthSortPolyData.h.

virtual void ssDepthSortPolyData::SetSortScalars ( int  arg  )  [inline, virtual]

Specify a flag that controls the generation of scalar values corresponding to the sort order.

If enabled, the output of this filter will include scalar values that range from 0 to (ncells-1), where 0 is closest to the sort direction.

Parameters:
arg The value of the argument. If non zero then scalars are sorted.

Definition at line 278 of file ssDepthSortPolyData.h.

virtual int ssDepthSortPolyData::GetSortScalars (  )  [inline, virtual]

Give the flag that controls generation of the scalar values corresponding to the sort order.

Definition at line 287 of file ssDepthSortPolyData.h.

virtual void ssDepthSortPolyData::SortScalarsOn (  )  [inline, virtual]

Specify the sorting of scalars.

Definition at line 295 of file ssDepthSortPolyData.h.

virtual void ssDepthSortPolyData::SortScalarsOff (  )  [inline, virtual]

Specify no sorting of scalars.

Definition at line 303 of file ssDepthSortPolyData.h.

unsigned long ssDepthSortPolyData::GetMTime (  )  [virtual]

Return MTime also considering the dependent objects: the camera and/or the prop3D.

Returns:
The time of the last modification.

Reimplemented from vtkObject.

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

Definition at line 319 of file ssDepthSortPolyData.h.

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

Execute the algorithm,.

Reimplemented from vtkSource.

void ssDepthSortPolyData::ComputeProjectionVector ( double  vector[3],
double  origin[3] 
) [protected]

Give a vector from the camera to the focal point.

Parameters:
vector The vector returned.
origin The origin of the vector returned.


Member Data Documentation

int ssDepthSortPolyData::Direction [protected]

Definition at line 333 of file ssDepthSortPolyData.h.

vtkCamera* ssDepthSortPolyData::Camera [protected]

Definition at line 334 of file ssDepthSortPolyData.h.

vtkProp3D* ssDepthSortPolyData::Prop3D [protected]

Definition at line 335 of file ssDepthSortPolyData.h.

vtkTransform* ssDepthSortPolyData::Transform [protected]

Definition at line 336 of file ssDepthSortPolyData.h.

double ssDepthSortPolyData::Vector[3] [protected]

Definition at line 337 of file ssDepthSortPolyData.h.

double ssDepthSortPolyData::Origin[3] [protected]

Definition at line 338 of file ssDepthSortPolyData.h.

int ssDepthSortPolyData::SortScalars [protected]

Definition at line 339 of file ssDepthSortPolyData.h.


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