vtkRIBProperty Class Reference

RIP Property. More...

#include <vtkRIBProperty.h>

Inheritance diagram for vtkRIBProperty:

Collaboration diagram for vtkRIBProperty:

Public Types
typedef vtkProperty	Superclass
Public Types inherited from vtkProperty
typedef vtkObject	Superclass
enum	VTKTextureUnit {   VTK_TEXTURE_UNIT_0 = 0, VTK_TEXTURE_UNIT_1, VTK_TEXTURE_UNIT_2, VTK_TEXTURE_UNIT_3,   VTK_TEXTURE_UNIT_4, VTK_TEXTURE_UNIT_5, VTK_TEXTURE_UNIT_6, VTK_TEXTURE_UNIT_7 }
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkRIBProperty *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
char *	GetDeclarations ()
virtual void	SetSurfaceShaderUsesDefaultParameters (bool)
virtual bool	GetSurfaceShaderUsesDefaultParameters ()
virtual void	SurfaceShaderUsesDefaultParametersOn ()
virtual void	SurfaceShaderUsesDefaultParametersOff ()
virtual void	SetSurfaceShader (const char *)
virtual char *	GetSurfaceShader ()
virtual void	SetDisplacementShader (const char *)
virtual char *	GetDisplacementShader ()
void	SetVariable (const char *variable, const char *declaration)
void	AddVariable (const char *variable, const char *declaration)
void	SetParameter (const char *parameter, const char *value)
void	AddParameter (const char *parameter, const char *value)
void	SetSurfaceShaderParameter (const char *parameter, const char *value)
void	AddSurfaceShaderParameter (const char *parameter, const char *value)
void	SetDisplacementShaderParameter (const char *parameter, const char *value)
void	AddDisplacementShaderParameter (const char *parameter, const char *value)
char *	GetParameters ()
char *	GetSurfaceShaderParameters ()
char *	GetDisplacementShaderParameters ()
Public Member Functions inherited from vtkProperty
vtkProperty *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	DeepCopy (vtkProperty *p)
virtual void	BackfaceRender (vtkActor *, vtkRenderer *)
void	RemoveTexture (const char *name)
void	RemoveAllTextures ()
int	GetNumberOfTextures ()
virtual void	ReleaseGraphicsResources (vtkWindow *win)
virtual void	PostRender (vtkActor *, vtkRenderer *)
virtual bool	GetLighting ()
virtual void	SetLighting (bool)
virtual void	LightingOn ()
virtual void	LightingOff ()
virtual void	SetInterpolation (int)
virtual int	GetInterpolation ()
void	SetInterpolationToFlat ()
void	SetInterpolationToGouraud ()
void	SetInterpolationToPhong ()
const char *	GetInterpolationAsString ()
virtual void	SetRepresentation (int)
virtual int	GetRepresentation ()
void	SetRepresentationToPoints ()
void	SetRepresentationToWireframe ()
void	SetRepresentationToSurface ()
const char *	GetRepresentationAsString ()
virtual void	SetColor (double r, double g, double b)
virtual void	SetColor (double a[3])
double *	GetColor ()
void	GetColor (double rgb[3])
void	GetColor (double &r, double &g, double &b)
virtual void	SetAmbient (double)
virtual double	GetAmbient ()
virtual void	SetDiffuse (double)
virtual double	GetDiffuse ()
virtual void	SetSpecular (double)
virtual double	GetSpecular ()
virtual void	SetSpecularPower (double)
virtual double	GetSpecularPower ()
virtual void	SetOpacity (double)
virtual double	GetOpacity ()
virtual void	SetAmbientColor (double, double, double)
virtual void	SetAmbientColor (double[3])
virtual double *	GetAmbientColor ()
virtual void	GetAmbientColor (double &, double &, double &)
virtual void	GetAmbientColor (double[3])
virtual void	SetDiffuseColor (double, double, double)
virtual void	SetDiffuseColor (double[3])
virtual double *	GetDiffuseColor ()
virtual void	GetDiffuseColor (double &, double &, double &)
virtual void	GetDiffuseColor (double[3])
virtual void	SetSpecularColor (double, double, double)
virtual void	SetSpecularColor (double[3])
virtual double *	GetSpecularColor ()
virtual void	GetSpecularColor (double &, double &, double &)
virtual void	GetSpecularColor (double[3])
virtual int	GetEdgeVisibility ()
virtual void	SetEdgeVisibility (int)
virtual void	EdgeVisibilityOn ()
virtual void	EdgeVisibilityOff ()
virtual void	SetEdgeColor (double, double, double)
virtual void	SetEdgeColor (double[3])
virtual double *	GetEdgeColor ()
virtual void	GetEdgeColor (double &, double &, double &)
virtual void	GetEdgeColor (double[3])
virtual void	SetLineWidth (float)
virtual float	GetLineWidth ()
virtual void	SetLineStipplePattern (int)
virtual int	GetLineStipplePattern ()
virtual void	SetLineStippleRepeatFactor (int)
virtual int	GetLineStippleRepeatFactor ()
virtual void	SetPointSize (float)
virtual float	GetPointSize ()
virtual int	GetBackfaceCulling ()
virtual void	SetBackfaceCulling (int)
virtual void	BackfaceCullingOn ()
virtual void	BackfaceCullingOff ()
virtual int	GetFrontfaceCulling ()
virtual void	SetFrontfaceCulling (int)
virtual void	FrontfaceCullingOn ()
virtual void	FrontfaceCullingOff ()
virtual char *	GetMaterialName ()
virtual void	SetShading (int)
virtual int	GetShading ()
virtual void	ShadingOn ()
virtual void	ShadingOff ()
virtual vtkShaderDeviceAdapter2 *	GetShaderDeviceAdapter2 ()
virtual void	AddShaderVariable (const char *name, int numVars, int *x)
virtual void	AddShaderVariable (const char *name, int numVars, float *x)
virtual void	AddShaderVariable (const char *name, int numVars, double *x)
void	AddShaderVariable (const char *name, int v)
void	AddShaderVariable (const char *name, float v)
void	AddShaderVariable (const char *name, double v)
void	AddShaderVariable (const char *name, int v1, int v2)
void	AddShaderVariable (const char *name, float v1, float v2)
void	AddShaderVariable (const char *name, double v1, double v2)
void	AddShaderVariable (const char *name, int v1, int v2, int v3)
void	AddShaderVariable (const char *name, float v1, float v2, float v3)
void	AddShaderVariable (const char *name, double v1, double v2, double v3)
void	SetTexture (const char *name, vtkTexture *texture)
vtkTexture *	GetTexture (const char *name)
void	SetTexture (int unit, vtkTexture *texture)
vtkTexture *	GetTexture (int unit)
void	RemoveTexture (int unit)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkRIBProperty *	New ()
static int	IsTypeOf (const char *type)
static vtkRIBProperty *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkProperty
static int	IsTypeOf (const char *type)
static vtkProperty *	SafeDownCast (vtkObjectBase *o)
static vtkProperty *	New ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkRIBProperty ()
	~vtkRIBProperty ()
void	Render (vtkActor *a, vtkRenderer *ren)
Protected Member Functions inherited from vtkProperty
	vtkProperty ()
	~vtkProperty ()
virtual void	SetMaterialName (const char *)
vtkTexture *	GetTextureAtIndex (int index)
int	GetTextureUnitAtIndex (int index)
int	GetTextureUnit (const char *name)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkProperty *	Property
char *	SurfaceShader
char *	DisplacementShader
char *	Declarations
char *	SurfaceShaderParameters
char *	DisplacementShaderParameters
bool	SurfaceShaderUsesDefaultParameters
Protected Attributes inherited from vtkProperty
double	Color [3]
double	AmbientColor [3]
double	DiffuseColor [3]
double	SpecularColor [3]
double	EdgeColor [3]
double	Ambient
double	Diffuse
double	Specular
double	SpecularPower
double	Opacity
float	PointSize
float	LineWidth
int	LineStipplePattern
int	LineStippleRepeatFactor
int	Interpolation
int	Representation
int	EdgeVisibility
int	BackfaceCulling
int	FrontfaceCulling
bool	Lighting
int	Shading
char *	MaterialName
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkProperty
static void	ComputeCompositeColor (double result[3], double ambient, const double ambient_color[3], double diffuse, const double diffuse_color[3], double specular, const double specular_color[3])

Detailed Description

RIP Property.

vtkRIBProperty is a subclass of vtkProperty that allows the user to specify named shaders for use with RenderMan. Both surface and displacement shaders can be specified. Parameters for the shaders can be declared and set.

See also

vtkRIBExporter vtkRIBLight

Tests:

vtkRIBProperty (Tests)

Definition at line 38 of file vtkRIBProperty.h.

Member Typedef Documentation

typedef vtkProperty vtkRIBProperty::Superclass

Definition at line 42 of file vtkRIBProperty.h.

Constructor & Destructor Documentation

vtkRIBProperty::vtkRIBProperty ( )

protected

vtkRIBProperty::~vtkRIBProperty ( )

protected

Member Function Documentation

static vtkRIBProperty* vtkRIBProperty::New ( )

static

static int vtkRIBProperty::IsTypeOf ( const char *  type )

static

virtual int vtkRIBProperty::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 vtkProperty.

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

static

virtual vtkObjectBase* vtkRIBProperty::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkProperty.

vtkRIBProperty* vtkRIBProperty::NewInstance

(

)

const

void vtkRIBProperty::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 vtkObject.

virtual void vtkRIBProperty::SetSurfaceShaderUsesDefaultParameters ( bool  )

virtual

If true (default) the surface shader uses the usual shader parameters: Ka - Ambient amount Kd - Diffuse amount Ks - Specular amount Roughness SpecularColor Additional surface shader parameters can be added with the Set/AddSurfaceShaderParameter methods. If false, all surface shader parameters must be specified

virtual bool vtkRIBProperty::GetSurfaceShaderUsesDefaultParameters ( )

virtual

If true (default) the surface shader uses the usual shader parameters: Ka - Ambient amount Kd - Diffuse amount Ks - Specular amount Roughness SpecularColor Additional surface shader parameters can be added with the Set/AddSurfaceShaderParameter methods. If false, all surface shader parameters must be specified

virtual void vtkRIBProperty::SurfaceShaderUsesDefaultParametersOn ( )

virtual

If true (default) the surface shader uses the usual shader parameters: Ka - Ambient amount Kd - Diffuse amount Ks - Specular amount Roughness SpecularColor Additional surface shader parameters can be added with the Set/AddSurfaceShaderParameter methods. If false, all surface shader parameters must be specified

virtual void vtkRIBProperty::SurfaceShaderUsesDefaultParametersOff ( )

virtual

If true (default) the surface shader uses the usual shader parameters: Ka - Ambient amount Kd - Diffuse amount Ks - Specular amount Roughness SpecularColor Additional surface shader parameters can be added with the Set/AddSurfaceShaderParameter methods. If false, all surface shader parameters must be specified

virtual void vtkRIBProperty::SetSurfaceShader ( const char *  )

virtual

Specify the name of a surface shader.

virtual char* vtkRIBProperty::GetSurfaceShader ( )

virtual

Specify the name of a surface shader.

virtual void vtkRIBProperty::SetDisplacementShader ( const char *  )

virtual

Specify the name of a displacement shader.

virtual char* vtkRIBProperty::GetDisplacementShader ( )

virtual

Specify the name of a displacement shader.

void vtkRIBProperty::SetVariable	(	const char *	variable,
		const char *	declaration
	)

Specify declarations for variables..

void vtkRIBProperty::AddVariable	(	const char *	variable,
		const char *	declaration
	)

Specify declarations for variables..

char* vtkRIBProperty::GetDeclarations

(

)

Get variable declarations

void vtkRIBProperty::SetParameter	(	const char *	parameter,
		const char *	value
	)

Specify parameter values for variables. DEPRECATED: use (Set/Add)SurfaceShaderParameter instead.

void vtkRIBProperty::AddParameter	(	const char *	parameter,
		const char *	value
	)

Specify parameter values for variables. DEPRECATED: use (Set/Add)SurfaceShaderParameter instead.

void vtkRIBProperty::SetSurfaceShaderParameter	(	const char *	parameter,
		const char *	value
	)

Specify parameter values for surface shader parameters

void vtkRIBProperty::AddSurfaceShaderParameter	(	const char *	parameter,
		const char *	value
	)

Specify parameter values for surface shader parameters

void vtkRIBProperty::SetDisplacementShaderParameter	(	const char *	parameter,
		const char *	value
	)

Specify parameter values for displacement shader parameters

void vtkRIBProperty::AddDisplacementShaderParameter	(	const char *	parameter,
		const char *	value
	)

Specify parameter values for displacement shader parameters

char* vtkRIBProperty::GetParameters

(

)

Get parameters.

char* vtkRIBProperty::GetSurfaceShaderParameters

(

)

Get parameters.

char* vtkRIBProperty::GetDisplacementShaderParameters

(

)

Get parameters.

void vtkRIBProperty::Render ( vtkActor *  , vtkRenderer *    )

protectedvirtual

This method causes the property to set up whatever is required for its instance variables. This is actually handled by a subclass of vtkProperty, which is created automatically. This method includes the invoking actor as an argument which can be used by property devices that require the actor.

Reimplemented from vtkProperty.

Member Data Documentation

vtkProperty* vtkRIBProperty::Property

protected

Definition at line 108 of file vtkRIBProperty.h.

char* vtkRIBProperty::SurfaceShader

protected

Definition at line 109 of file vtkRIBProperty.h.

char* vtkRIBProperty::DisplacementShader

protected

Definition at line 110 of file vtkRIBProperty.h.

char* vtkRIBProperty::Declarations

protected

Definition at line 111 of file vtkRIBProperty.h.

char* vtkRIBProperty::SurfaceShaderParameters

protected

Definition at line 112 of file vtkRIBProperty.h.

char* vtkRIBProperty::DisplacementShaderParameters

protected

Definition at line 113 of file vtkRIBProperty.h.

bool vtkRIBProperty::SurfaceShaderUsesDefaultParameters

protected

Definition at line 114 of file vtkRIBProperty.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/Export/vtkRIBProperty.h