VTK  9.3.20240717
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkRIBProperty Class Reference

RIP Property. More...

#include <vtkRIBProperty.h>

Inheritance diagram for vtkRIBProperty:
[legend]
Collaboration diagram for vtkRIBProperty:
[legend]

Public Types

typedef vtkProperty Superclass
 
- Public Types inherited from vtkProperty
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkRIBPropertyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
char * GetDeclarations ()
 Get variable declarations.
 
virtual void SetSurfaceShaderUsesDefaultParameters (bool)
 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.
 
virtual bool GetSurfaceShaderUsesDefaultParameters ()
 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.
 
virtual void SurfaceShaderUsesDefaultParametersOn ()
 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.
 
virtual void SurfaceShaderUsesDefaultParametersOff ()
 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.
 
virtual void SetSurfaceShader (const char *)
 Specify the name of a surface shader.
 
virtual char * GetSurfaceShader ()
 Specify the name of a surface shader.
 
virtual void SetDisplacementShader (const char *)
 Specify the name of a displacement shader.
 
virtual char * GetDisplacementShader ()
 Specify the name of a displacement shader.
 
void SetVariable (const char *variable, const char *declaration)
 Specify declarations for variables.
 
void AddVariable (const char *variable, const char *declaration)
 Specify declarations for variables.
 
void SetParameter (const char *parameter, const char *value)
 Specify parameter values for variables.
 
void AddParameter (const char *parameter, const char *value)
 Specify parameter values for variables.
 
void SetSurfaceShaderParameter (const char *parameter, const char *value)
 Specify parameter values for surface shader parameters.
 
void AddSurfaceShaderParameter (const char *parameter, const char *value)
 Specify parameter values for surface shader parameters.
 
void SetDisplacementShaderParameter (const char *parameter, const char *value)
 Specify parameter values for displacement shader parameters.
 
void AddDisplacementShaderParameter (const char *parameter, const char *value)
 Specify parameter values for displacement shader parameters.
 
char * GetParameters ()
 Get parameters.
 
char * GetSurfaceShaderParameters ()
 Get parameters.
 
char * GetDisplacementShaderParameters ()
 Get parameters.
 
- Public Member Functions inherited from vtkProperty
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPropertyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void DeepCopy (vtkProperty *p)
 Assign one property to another.
 
virtual void Render (vtkActor *, vtkRenderer *)
 This method causes the property to set up whatever is required for its instance variables.
 
virtual void BackfaceRender (vtkActor *, vtkRenderer *)
 This method renders the property as a backface property.
 
virtual void PostRender (vtkActor *, vtkRenderer *)
 This method is called after the actor has been rendered.
 
void SetBaseColorTexture (vtkTexture *texture)
 Set the base color texture.
 
void SetORMTexture (vtkTexture *texture)
 Set the ORM texture.
 
void SetAnisotropyTexture (vtkTexture *texture)
 Set the anisotropy texture.
 
void SetNormalTexture (vtkTexture *texture)
 Set the normal texture.
 
void SetEmissiveTexture (vtkTexture *texture)
 Set the emissive texture.
 
void SetCoatNormalTexture (vtkTexture *texture)
 Set the coat normal texture.
 
void RemoveTexture (const char *name)
 Remove a texture from the collection.
 
void RemoveAllTextures ()
 Remove all the textures.
 
int GetNumberOfTextures ()
 Returns the number of textures in this property.
 
std::map< std::string, vtkTexture * > & GetAllTextures ()
 Returns all the textures in this property and their names.
 
virtual void ReleaseGraphicsResources (vtkWindow *win)
 Release any graphics resources that are being consumed by this property.
 
virtual bool GetLighting ()
 Set/Get lighting flag for an object.
 
virtual void SetLighting (bool)
 Set/Get lighting flag for an object.
 
virtual void LightingOn ()
 Set/Get lighting flag for an object.
 
virtual void LightingOff ()
 Set/Get lighting flag for an object.
 
virtual bool GetRenderPointsAsSpheres ()
 Set/Get rendering of points as spheres.
 
virtual void SetRenderPointsAsSpheres (bool)
 Set/Get rendering of points as spheres.
 
virtual void RenderPointsAsSpheresOn ()
 Set/Get rendering of points as spheres.
 
virtual void RenderPointsAsSpheresOff ()
 Set/Get rendering of points as spheres.
 
virtual bool GetRenderLinesAsTubes ()
 Set/Get rendering of lines as tubes.
 
virtual void SetRenderLinesAsTubes (bool)
 Set/Get rendering of lines as tubes.
 
virtual void RenderLinesAsTubesOn ()
 Set/Get rendering of lines as tubes.
 
virtual void RenderLinesAsTubesOff ()
 Set/Get rendering of lines as tubes.
 
virtual void SetInterpolation (int)
 Set the shading interpolation method for an object.
 
virtual int GetInterpolation ()
 Set the shading interpolation method for an object.
 
void SetInterpolationToFlat ()
 Set the shading interpolation method for an object.
 
void SetInterpolationToGouraud ()
 Set the shading interpolation method for an object.
 
void SetInterpolationToPhong ()
 Set the shading interpolation method for an object.
 
void SetInterpolationToPBR ()
 Set the shading interpolation method for an object.
 
const char * GetInterpolationAsString ()
 Return the method of shading as a descriptive character string.
 
virtual void SetRepresentation (int)
 Control the surface geometry representation for the object.
 
virtual int GetRepresentation ()
 Control the surface geometry representation for the object.
 
void SetRepresentationToPoints ()
 Control the surface geometry representation for the object.
 
void SetRepresentationToWireframe ()
 Control the surface geometry representation for the object.
 
void SetRepresentationToSurface ()
 Control the surface geometry representation for the object.
 
const char * GetRepresentationAsString ()
 Return the method of shading as a descriptive character string.
 
virtual void SetColor (double r, double g, double b)
 Set the color of the object.
 
virtual void SetColor (double a[3])
 Set the color of the object.
 
double * GetColor ()
 Set the color of the object.
 
void GetColor (double rgb[3])
 Set the color of the object.
 
void GetColor (double &r, double &g, double &b)
 Set the color of the object.
 
virtual void SetBaseIOR (double)
 Set/Get the Index Of Refraction of the base layer.
 
virtual double GetBaseIOR ()
 Set/Get the Index Of Refraction of the base layer.
 
virtual void SetMetallic (double)
 Set/Get the metallic coefficient.
 
virtual double GetMetallic ()
 Set/Get the metallic coefficient.
 
virtual void SetRoughness (double)
 Set/Get the roughness coefficient.
 
virtual double GetRoughness ()
 Set/Get the roughness coefficient.
 
virtual void SetAnisotropy (double)
 Set/Get the anisotropy coefficient.
 
virtual double GetAnisotropy ()
 Set/Get the anisotropy coefficient.
 
virtual void SetAnisotropyRotation (double)
 Set/Get the anisotropy rotation coefficient.
 
virtual double GetAnisotropyRotation ()
 Set/Get the anisotropy rotation coefficient.
 
virtual void SetCoatIOR (double)
 Set/Get the coat layer Index Of Refraction.
 
virtual double GetCoatIOR ()
 Set/Get the coat layer Index Of Refraction.
 
virtual void SetCoatRoughness (double)
 Set/Get the coat layer roughness coefficient.
 
virtual double GetCoatRoughness ()
 Set/Get the coat layer roughness coefficient.
 
virtual void SetCoatStrength (double)
 Set/Get the coat layer strength coefficient.
 
virtual double GetCoatStrength ()
 Set/Get the coat layer strength coefficient.
 
virtual void SetCoatColor (double, double, double)
 Set/Get the color of the coat layer.
 
virtual void SetCoatColor (double[3])
 Set/Get the color of the coat layer.
 
virtual double * GetCoatColor ()
 Set/Get the color of the coat layer.
 
virtual void GetCoatColor (double &, double &, double &)
 Set/Get the color of the coat layer.
 
virtual void GetCoatColor (double[3])
 Set/Get the color of the coat layer.
 
virtual void SetCoatNormalScale (double)
 Set/Get the coat layer normal scale coefficient.
 
virtual double GetCoatNormalScale ()
 Set/Get the coat layer normal scale coefficient.
 
virtual void SetNormalScale (double)
 Set/Get the normal scale coefficient.
 
virtual double GetNormalScale ()
 Set/Get the normal scale coefficient.
 
virtual void SetOcclusionStrength (double)
 Set/Get the occlusion strength coefficient.
 
virtual double GetOcclusionStrength ()
 Set/Get the occlusion strength coefficient.
 
virtual void SetEmissiveFactor (double, double, double)
 Set/Get the emissive factor.
 
virtual void SetEmissiveFactor (double[3])
 Set/Get the emissive factor.
 
virtual double * GetEmissiveFactor ()
 Set/Get the emissive factor.
 
virtual void GetEmissiveFactor (double &, double &, double &)
 Set/Get the emissive factor.
 
virtual void GetEmissiveFactor (double[3])
 Set/Get the emissive factor.
 
virtual void SetEdgeTint (double, double, double)
 Set/Get the edge tint (for metals only).
 
virtual void SetEdgeTint (double[3])
 Set/Get the edge tint (for metals only).
 
virtual double * GetEdgeTint ()
 Set/Get the edge tint (for metals only).
 
virtual void GetEdgeTint (double &, double &, double &)
 Set/Get the edge tint (for metals only).
 
virtual void GetEdgeTint (double[3])
 Set/Get the edge tint (for metals only).
 
virtual void SetAmbient (double)
 Set/Get the ambient lighting coefficient.
 
virtual double GetAmbient ()
 Set/Get the ambient lighting coefficient.
 
virtual void SetDiffuse (double)
 Set/Get the diffuse lighting coefficient.
 
virtual double GetDiffuse ()
 Set/Get the diffuse lighting coefficient.
 
virtual void SetSpecular (double)
 Set/Get the specular lighting coefficient.
 
virtual double GetSpecular ()
 Set/Get the specular lighting coefficient.
 
virtual void SetSpecularPower (double)
 Set/Get the specular power.
 
virtual double GetSpecularPower ()
 Set/Get the specular power.
 
virtual void SetOpacity (double)
 Set/Get the object's opacity.
 
virtual double GetOpacity ()
 Set/Get the object's opacity.
 
virtual void SetEdgeOpacity (double)
 Set/Get the line opacity.
 
virtual double GetEdgeOpacity ()
 Set/Get the line opacity.
 
virtual void SetAmbientColor (double, double, double)
 Set/Get the ambient surface color.
 
virtual void SetAmbientColor (double[3])
 Set/Get the ambient surface color.
 
virtual double * GetAmbientColor ()
 Set/Get the ambient surface color.
 
virtual void GetAmbientColor (double &, double &, double &)
 Set/Get the ambient surface color.
 
virtual void GetAmbientColor (double[3])
 Set/Get the ambient surface color.
 
virtual void SetDiffuseColor (double, double, double)
 Set/Get the diffuse surface color.
 
virtual void SetDiffuseColor (double[3])
 Set/Get the diffuse surface color.
 
virtual double * GetDiffuseColor ()
 Set/Get the diffuse surface color.
 
virtual void GetDiffuseColor (double &, double &, double &)
 Set/Get the diffuse surface color.
 
virtual void GetDiffuseColor (double[3])
 Set/Get the diffuse surface color.
 
virtual void SetSpecularColor (double, double, double)
 Set/Get the specular surface color.
 
virtual void SetSpecularColor (double[3])
 Set/Get the specular surface color.
 
virtual double * GetSpecularColor ()
 Set/Get the specular surface color.
 
virtual void GetSpecularColor (double &, double &, double &)
 Set/Get the specular surface color.
 
virtual void GetSpecularColor (double[3])
 Set/Get the specular surface color.
 
virtual vtkTypeBool GetEdgeVisibility ()
 Turn on/off the visibility of edges.
 
virtual void SetEdgeVisibility (vtkTypeBool)
 Turn on/off the visibility of edges.
 
virtual void EdgeVisibilityOn ()
 Turn on/off the visibility of edges.
 
virtual void EdgeVisibilityOff ()
 Turn on/off the visibility of edges.
 
virtual void SetEdgeColor (double, double, double)
 Set/Get the color of primitive edges (if edge visibility is enabled).
 
virtual void SetEdgeColor (double[3])
 Set/Get the color of primitive edges (if edge visibility is enabled).
 
virtual double * GetEdgeColor ()
 Set/Get the color of primitive edges (if edge visibility is enabled).
 
virtual void GetEdgeColor (double &, double &, double &)
 Set/Get the color of primitive edges (if edge visibility is enabled).
 
virtual void GetEdgeColor (double[3])
 Set/Get the color of primitive edges (if edge visibility is enabled).
 
virtual vtkTypeBool GetVertexVisibility ()
 Turn on/off the visibility of vertices.
 
virtual void SetVertexVisibility (vtkTypeBool)
 Turn on/off the visibility of vertices.
 
virtual void VertexVisibilityOn ()
 Turn on/off the visibility of vertices.
 
virtual void VertexVisibilityOff ()
 Turn on/off the visibility of vertices.
 
virtual void SetVertexColor (double, double, double)
 Set/Get the color of primitive vertices (if vertex visibility is enabled).
 
virtual void SetVertexColor (double[3])
 Set/Get the color of primitive vertices (if vertex visibility is enabled).
 
virtual double * GetVertexColor ()
 Set/Get the color of primitive vertices (if vertex visibility is enabled).
 
virtual void GetVertexColor (double &, double &, double &)
 Set/Get the color of primitive vertices (if vertex visibility is enabled).
 
virtual void GetVertexColor (double[3])
 Set/Get the color of primitive vertices (if vertex visibility is enabled).
 
virtual void SetSelectionColor (double, double, double, double)
 Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).
 
virtual void SetSelectionColor (double[4])
 Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).
 
virtual double * GetSelectionColor ()
 Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).
 
virtual void GetSelectionColor (double &, double &, double &, double &)
 Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).
 
virtual void GetSelectionColor (double[4])
 Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).
 
virtual void SetSelectionLineWidth (float)
 Set/Get the selection line width.
 
virtual float GetSelectionLineWidth ()
 Set/Get the selection line width.
 
virtual void SetSelectionPointSize (float)
 Set/Get the selection point size.
 
virtual float GetSelectionPointSize ()
 Set/Get the selection point size.
 
virtual void SetLineWidth (float)
 Set/Get the width of a Line.
 
virtual float GetLineWidth ()
 Set/Get the width of a Line.
 
virtual void SetLineStipplePattern (int)
 Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off).
 
virtual int GetLineStipplePattern ()
 Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off).
 
virtual void SetLineStippleRepeatFactor (int)
 Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated.
 
virtual int GetLineStippleRepeatFactor ()
 Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated.
 
virtual void SetPointSize (float)
 Set/Get the diameter of a point.
 
virtual float GetPointSize ()
 Set/Get the diameter of a point.
 
virtual vtkTypeBool GetBackfaceCulling ()
 Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
 
virtual void SetBackfaceCulling (vtkTypeBool)
 Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
 
virtual void BackfaceCullingOn ()
 Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
 
virtual void BackfaceCullingOff ()
 Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
 
virtual vtkTypeBool GetFrontfaceCulling ()
 Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
 
virtual void SetFrontfaceCulling (vtkTypeBool)
 Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
 
virtual void FrontfaceCullingOn ()
 Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
 
virtual void FrontfaceCullingOff ()
 Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
 
virtual void SetMaterialName (const char *)
 Returns the name of the material currently loaded, if any.
 
virtual char * GetMaterialName ()
 Returns the name of the material currently loaded, if any.
 
virtual void SetShading (vtkTypeBool)
 Enable/Disable shading.
 
virtual vtkTypeBool GetShading ()
 Enable/Disable shading.
 
virtual void ShadingOn ()
 Enable/Disable shading.
 
virtual void ShadingOff ()
 Enable/Disable shading.
 
virtual void AddShaderVariable (const char *name, int numVars, int *x)
 Provide values to initialize shader variables.
 
virtual void AddShaderVariable (const char *name, int numVars, float *x)
 Provide values to initialize shader variables.
 
virtual void AddShaderVariable (const char *name, int numVars, double *x)
 Provide values to initialize shader variables.
 
void AddShaderVariable (const char *name, int v)
 Methods to provide to add shader variables from wrappers.
 
void AddShaderVariable (const char *name, float v)
 Methods to provide to add shader variables from wrappers.
 
void AddShaderVariable (const char *name, double v)
 Methods to provide to add shader variables from wrappers.
 
void AddShaderVariable (const char *name, int v1, int v2)
 Methods to provide to add shader variables from wrappers.
 
void AddShaderVariable (const char *name, float v1, float v2)
 Methods to provide to add shader variables from wrappers.
 
void AddShaderVariable (const char *name, double v1, double v2)
 Methods to provide to add shader variables from wrappers.
 
void AddShaderVariable (const char *name, int v1, int v2, int v3)
 Methods to provide to add shader variables from wrappers.
 
void AddShaderVariable (const char *name, float v1, float v2, float v3)
 Methods to provide to add shader variables from wrappers.
 
void AddShaderVariable (const char *name, double v1, double v2, double v3)
 Methods to provide to add shader variables from wrappers.
 
virtual void SetShowTexturesOnBackface (bool)
 Show texture maps when the geometry is backfacing.
 
virtual bool GetShowTexturesOnBackface ()
 Show texture maps when the geometry is backfacing.
 
virtual void ShowTexturesOnBackfaceOn ()
 Show texture maps when the geometry is backfacing.
 
virtual void ShowTexturesOnBackfaceOff ()
 Show texture maps when the geometry is backfacing.
 
void SetTexture (const char *name, vtkTexture *texture)
 Set/Get the texture object to control rendering texture maps.
 
vtkTextureGetTexture (const char *name)
 Set/Get the texture object to control rendering texture maps.
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with the Property.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with the Property.
 
double ComputeReflectanceOfBaseLayer ()
 For PBR, calculate the reflectance of the base layer depending on the presence of a coat layer.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
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).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkRIBPropertyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRIBPropertySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProperty
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropertySafeDownCast (vtkObjectBase *o)
 
static vtkPropertyNew ()
 Construct object with object color, ambient color, diffuse color, specular color, and edge color white; ambient coefficient=0; diffuse coefficient=0; specular coefficient=0; specular power=1; Gouraud shading; and surface representation.
 
static double ComputeReflectanceFromIOR (double IORTo, double IORFrom)
 For PBR, calculate the reflectance from the refractive index of ingoing and outgoing interfaces.
 
static double ComputeIORFromReflectance (double reflectance, double ior)
 For PBR, calculate the refractive index from the reflectance of the interface and the refractive index of one of both medium.
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
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).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
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.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRIBProperty ()
 
 ~vtkRIBProperty () override
 
void Render (vtkActor *a, vtkRenderer *ren) override
 This method causes the property to set up whatever is required for its instance variables.
 
- Protected Member Functions inherited from vtkProperty
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkProperty ()
 
 ~vtkProperty () override
 
- 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkPropertyProperty
 
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 VertexColor [3]
 
double SelectionColor [4] = { 1.0, 0.0, 0.0, 1.0 }
 
double Ambient
 
double Diffuse
 
double Metallic
 
double Roughness
 
double Anisotropy
 
double AnisotropyRotation
 
double BaseIOR
 
double CoatIOR
 
double CoatColor [3]
 
double CoatRoughness
 
double CoatStrength
 
double CoatNormalScale
 
double NormalScale
 
double OcclusionStrength
 
double EmissiveFactor [3]
 
double Specular
 
double SpecularPower
 
double Opacity
 
double EdgeOpacity = 1.0
 
double EdgeTint [3]
 
float PointSize
 
float LineWidth
 
float SelectionPointSize = 2.f
 
float SelectionLineWidth = 2.f
 
int LineStipplePattern
 
int LineStippleRepeatFactor
 
int Interpolation
 
int Representation
 
vtkTypeBool EdgeVisibility
 
vtkTypeBool VertexVisibility
 
vtkTypeBool BackfaceCulling
 
vtkTypeBool FrontfaceCulling
 
bool Lighting
 
bool RenderPointsAsSpheres
 
bool RenderLinesAsTubes
 
bool ShowTexturesOnBackface
 
vtkTypeBool Shading
 
char * MaterialName
 
MapOfTextures Textures
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Protected Types inherited from vtkProperty
typedef std::map< std::string, vtkTexture * > MapOfTextures
 
- 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])
 Computes composite color.
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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
Online Examples:

Tests:
vtkRIBProperty (Tests)

Definition at line 47 of file vtkRIBProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 51 of file vtkRIBProperty.h.

Constructor & Destructor Documentation

◆ vtkRIBProperty()

vtkRIBProperty::vtkRIBProperty ( )
protected

◆ ~vtkRIBProperty()

vtkRIBProperty::~vtkRIBProperty ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkRIBProperty * vtkRIBProperty::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkRIBProperty::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkProperty.

◆ NewInstance()

vtkRIBProperty * vtkRIBProperty::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetSurfaceShaderUsesDefaultParameters()

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

◆ GetSurfaceShaderUsesDefaultParameters()

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

◆ SurfaceShaderUsesDefaultParametersOn()

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

◆ SurfaceShaderUsesDefaultParametersOff()

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

◆ SetSurfaceShader()

virtual void vtkRIBProperty::SetSurfaceShader ( const char *  )
virtual

Specify the name of a surface shader.

◆ GetSurfaceShader()

virtual char * vtkRIBProperty::GetSurfaceShader ( )
virtual

Specify the name of a surface shader.

◆ SetDisplacementShader()

virtual void vtkRIBProperty::SetDisplacementShader ( const char *  )
virtual

Specify the name of a displacement shader.

◆ GetDisplacementShader()

virtual char * vtkRIBProperty::GetDisplacementShader ( )
virtual

Specify the name of a displacement shader.

◆ SetVariable()

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

Specify declarations for variables.

◆ AddVariable()

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

Specify declarations for variables.

◆ GetDeclarations()

char * vtkRIBProperty::GetDeclarations ( )

Get variable declarations.

◆ SetParameter()

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

Specify parameter values for variables.

DEPRECATED: use (Set/Add)SurfaceShaderParameter instead.

◆ AddParameter()

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

Specify parameter values for variables.

DEPRECATED: use (Set/Add)SurfaceShaderParameter instead.

◆ SetSurfaceShaderParameter()

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

Specify parameter values for surface shader parameters.

◆ AddSurfaceShaderParameter()

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

Specify parameter values for surface shader parameters.

◆ SetDisplacementShaderParameter()

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

Specify parameter values for displacement shader parameters.

◆ AddDisplacementShaderParameter()

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

Specify parameter values for displacement shader parameters.

◆ GetParameters()

char * vtkRIBProperty::GetParameters ( )

Get parameters.

◆ GetSurfaceShaderParameters()

char * vtkRIBProperty::GetSurfaceShaderParameters ( )

Get parameters.

◆ GetDisplacementShaderParameters()

char * vtkRIBProperty::GetDisplacementShaderParameters ( )

Get parameters.

◆ Render()

void vtkRIBProperty::Render ( vtkActor ,
vtkRenderer  
)
overrideprotectedvirtual

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

◆ Property

vtkProperty* vtkRIBProperty::Property
protected

Definition at line 139 of file vtkRIBProperty.h.

◆ SurfaceShader

char* vtkRIBProperty::SurfaceShader
protected

Definition at line 140 of file vtkRIBProperty.h.

◆ DisplacementShader

char* vtkRIBProperty::DisplacementShader
protected

Definition at line 141 of file vtkRIBProperty.h.

◆ Declarations

char* vtkRIBProperty::Declarations
protected

Definition at line 142 of file vtkRIBProperty.h.

◆ SurfaceShaderParameters

char* vtkRIBProperty::SurfaceShaderParameters
protected

Definition at line 143 of file vtkRIBProperty.h.

◆ DisplacementShaderParameters

char* vtkRIBProperty::DisplacementShaderParameters
protected

Definition at line 144 of file vtkRIBProperty.h.

◆ SurfaceShaderUsesDefaultParameters

bool vtkRIBProperty::SurfaceShaderUsesDefaultParameters
protected

Definition at line 145 of file vtkRIBProperty.h.


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