vtkContextClip Class Reference

#include <vtkContextClip.h>

Inheritance diagram for vtkContextClip:

Inheritance graph
[legend]
Collaboration diagram for vtkContextClip:

Collaboration graph
[legend]

List of all members.


Detailed Description

all children of this item are clipped by the specified area.

This class can be used to clip the rendering of an item inside a rectangular area.

Definition at line 31 of file vtkContextClip.h.


Public Types

typedef vtkAbstractContextItem Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void Update ()
virtual bool Paint (vtkContext2D *painter)
virtual void SetClip (float x, float y, float width, float height)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkContextClipSafeDownCast (vtkObject *o)
static vtkContextClipNew ()

Protected Member Functions

 vtkContextClip ()
 ~vtkContextClip ()

Protected Attributes

float Dims [4]

Member Typedef Documentation

Reimplemented from vtkAbstractContextItem.

Definition at line 34 of file vtkContextClip.h.


Constructor & Destructor Documentation

vtkContextClip::vtkContextClip (  )  [protected]

vtkContextClip::~vtkContextClip (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkAbstractContextItem.

static int vtkContextClip::IsTypeOf ( const char *  name  )  [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 vtkAbstractContextItem.

virtual int vtkContextClip::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 vtkAbstractContextItem.

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

Reimplemented from vtkAbstractContextItem.

virtual void vtkContextClip::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 vtkAbstractContextItem.

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

Creates a vtkContextClip object.

Reimplemented from vtkObject.

virtual void vtkContextClip::Update (  )  [virtual]

Perform any updates to the item that may be necessary before rendering. The scene should take care of calling this on all items before their Paint function is invoked.

Reimplemented from vtkAbstractContextItem.

virtual bool vtkContextClip::Paint ( vtkContext2D painter  )  [virtual]

Paint event for the item, called whenever the item needs to be drawn.

Reimplemented from vtkAbstractContextItem.

virtual void vtkContextClip::SetClip ( float  x,
float  y,
float  width,
float  height 
) [virtual]

Set the origin, width and height of the clipping rectangle. These are in pixel coordinates.


Member Data Documentation

float vtkContextClip::Dims[4] [protected]

Definition at line 57 of file vtkContextClip.h.


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

Generated on Wed Aug 24 11:32:08 2011 for VTK by  doxygen 1.5.6