VTK
9.0.20210304
|
represent surface properties of a geometric object More...
#include <vtkProperty.h>
Public Types | |
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. More... | |
vtkProperty * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
void | DeepCopy (vtkProperty *p) |
Assign one property to another. More... | |
virtual void | Render (vtkActor *, vtkRenderer *) |
This method causes the property to set up whatever is required for its instance variables. More... | |
virtual void | BackfaceRender (vtkActor *, vtkRenderer *) |
This method renders the property as a backface property. More... | |
virtual void | PostRender (vtkActor *, vtkRenderer *) |
This method is called after the actor has been rendered. More... | |
virtual bool | GetLighting () |
Set/Get lighting flag for an object. More... | |
virtual void | SetLighting (bool) |
virtual void | LightingOn () |
virtual void | LightingOff () |
virtual bool | GetRenderPointsAsSpheres () |
Set/Get rendering of points as spheres. More... | |
virtual void | SetRenderPointsAsSpheres (bool) |
virtual void | RenderPointsAsSpheresOn () |
virtual void | RenderPointsAsSpheresOff () |
virtual bool | GetRenderLinesAsTubes () |
Set/Get rendering of lines as tubes. More... | |
virtual void | SetRenderLinesAsTubes (bool) |
virtual void | RenderLinesAsTubesOn () |
virtual void | RenderLinesAsTubesOff () |
virtual void | SetInterpolation (int) |
Set the shading interpolation method for an object. More... | |
virtual int | GetInterpolation () |
void | SetInterpolationToFlat () |
void | SetInterpolationToGouraud () |
void | SetInterpolationToPhong () |
void | SetInterpolationToPBR () |
const char * | GetInterpolationAsString () |
Return the method of shading as a descriptive character string. More... | |
virtual void | SetRepresentation (int) |
Control the surface geometry representation for the object. More... | |
virtual int | GetRepresentation () |
void | SetRepresentationToPoints () |
void | SetRepresentationToWireframe () |
void | SetRepresentationToSurface () |
const char * | GetRepresentationAsString () |
Return the method of shading as a descriptive character string. More... | |
virtual void | SetColor (double r, double g, double b) |
Set the color of the object. More... | |
virtual void | SetColor (double a[3]) |
double * | GetColor () |
void | GetColor (double rgb[3]) |
void | GetColor (double &r, double &g, double &b) |
virtual void | SetBaseIOR (double) |
Set/Get the Index Of Refraction of the base layer. More... | |
virtual double | GetBaseIOR () |
virtual void | SetMetallic (double) |
Set/Get the metallic coefficient. More... | |
virtual double | GetMetallic () |
virtual void | SetRoughness (double) |
Set/Get the roughness coefficient. More... | |
virtual double | GetRoughness () |
virtual void | SetAnisotropy (double) |
Set/Get the anisotropy coefficient. More... | |
virtual double | GetAnisotropy () |
virtual void | SetAnisotropyRotation (double) |
Set/Get the anisotropy rotation coefficient. More... | |
virtual double | GetAnisotropyRotation () |
virtual void | SetCoatIOR (double) |
Set/Get the coat layer Index Of Refraction. More... | |
virtual double | GetCoatIOR () |
virtual void | SetCoatRoughness (double) |
Set/Get the coat layer roughness coefficient. More... | |
virtual double | GetCoatRoughness () |
virtual void | SetCoatStrength (double) |
Set/Get the coat layer strength coefficient. More... | |
virtual double | GetCoatStrength () |
virtual void | SetCoatColor (double, double, double) |
Set/Get the color of the coat layer. More... | |
virtual void | SetCoatColor (double[3]) |
virtual double * | GetCoatColor () |
virtual void | GetCoatColor (double &, double &, double &) |
virtual void | GetCoatColor (double[3]) |
virtual void | SetCoatNormalScale (double) |
Set/Get the coat layer normal scale coefficient. More... | |
virtual double | GetCoatNormalScale () |
virtual void | SetNormalScale (double) |
Set/Get the normal scale coefficient. More... | |
virtual double | GetNormalScale () |
virtual void | SetOcclusionStrength (double) |
Set/Get the occlusion strength coefficient. More... | |
virtual double | GetOcclusionStrength () |
virtual void | SetEmissiveFactor (double, double, double) |
Set/Get the emissive factor. More... | |
virtual void | SetEmissiveFactor (double[3]) |
virtual double * | GetEmissiveFactor () |
virtual void | GetEmissiveFactor (double &, double &, double &) |
virtual void | GetEmissiveFactor (double[3]) |
virtual void | SetEdgeTint (double, double, double) |
Set/Get the edge tint (for metals only). More... | |
virtual void | SetEdgeTint (double[3]) |
virtual double * | GetEdgeTint () |
virtual void | GetEdgeTint (double &, double &, double &) |
virtual void | GetEdgeTint (double[3]) |
virtual void | SetAmbient (double) |
Set/Get the ambient lighting coefficient. More... | |
virtual double | GetAmbient () |
virtual void | SetDiffuse (double) |
Set/Get the diffuse lighting coefficient. More... | |
virtual double | GetDiffuse () |
virtual void | SetSpecular (double) |
Set/Get the specular lighting coefficient. More... | |
virtual double | GetSpecular () |
virtual void | SetSpecularPower (double) |
Set/Get the specular power. More... | |
virtual double | GetSpecularPower () |
virtual void | SetOpacity (double) |
Set/Get the object's opacity. More... | |
virtual double | GetOpacity () |
virtual void | SetAmbientColor (double, double, double) |
Set/Get the ambient surface color. More... | |
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) |
Set/Get the diffuse surface color. More... | |
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) |
Set/Get the specular surface color. More... | |
virtual void | SetSpecularColor (double[3]) |
virtual double * | GetSpecularColor () |
virtual void | GetSpecularColor (double &, double &, double &) |
virtual void | GetSpecularColor (double[3]) |
virtual vtkTypeBool | GetEdgeVisibility () |
Turn on/off the visibility of edges. More... | |
virtual void | SetEdgeVisibility (vtkTypeBool) |
virtual void | EdgeVisibilityOn () |
virtual void | EdgeVisibilityOff () |
virtual void | SetEdgeColor (double, double, double) |
Set/Get the color of primitive edges (if edge visibility is enabled). More... | |
virtual void | SetEdgeColor (double[3]) |
virtual double * | GetEdgeColor () |
virtual void | GetEdgeColor (double &, double &, double &) |
virtual void | GetEdgeColor (double[3]) |
virtual vtkTypeBool | GetVertexVisibility () |
Turn on/off the visibility of vertices. More... | |
virtual void | SetVertexVisibility (vtkTypeBool) |
virtual void | VertexVisibilityOn () |
virtual void | VertexVisibilityOff () |
virtual void | SetVertexColor (double, double, double) |
Set/Get the color of primitive vertices (if vertex visibility is enabled). More... | |
virtual void | SetVertexColor (double[3]) |
virtual double * | GetVertexColor () |
virtual void | GetVertexColor (double &, double &, double &) |
virtual void | GetVertexColor (double[3]) |
virtual void | SetSelectionColor (double, double, double, double) |
Set/Get the RGBA color of selection primitives (if a selection is active on the mapper). More... | |
virtual void | SetSelectionColor (double[4]) |
virtual double * | GetSelectionColor () |
virtual void | GetSelectionColor (double &, double &, double &, double &) |
virtual void | GetSelectionColor (double[4]) |
virtual void | SetSelectionLineWidth (float) |
Set/Get the selection line width. More... | |
virtual float | GetSelectionLineWidth () |
virtual void | SetSelectionPointSize (float) |
Set/Get the selection point size. More... | |
virtual float | GetSelectionPointSize () |
virtual void | SetLineWidth (float) |
Set/Get the width of a Line. More... | |
virtual float | GetLineWidth () |
virtual void | SetLineStipplePattern (int) |
Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off). More... | |
virtual int | GetLineStipplePattern () |
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. More... | |
virtual int | GetLineStippleRepeatFactor () |
virtual void | SetPointSize (float) |
Set/Get the diameter of a point. More... | |
virtual float | GetPointSize () |
virtual vtkTypeBool | GetBackfaceCulling () |
Turn on/off fast culling of polygons based on orientation of normal with respect to camera. More... | |
virtual void | SetBackfaceCulling (vtkTypeBool) |
virtual void | BackfaceCullingOn () |
virtual void | BackfaceCullingOff () |
virtual vtkTypeBool | GetFrontfaceCulling () |
Turn on/off fast culling of polygons based on orientation of normal with respect to camera. More... | |
virtual void | SetFrontfaceCulling (vtkTypeBool) |
virtual void | FrontfaceCullingOn () |
virtual void | FrontfaceCullingOff () |
virtual void | SetMaterialName (const char *) |
Returns the name of the material currently loaded, if any. More... | |
virtual char * | GetMaterialName () |
virtual void | SetShading (vtkTypeBool) |
Enable/Disable shading. More... | |
virtual vtkTypeBool | GetShading () |
virtual void | ShadingOn () |
virtual void | ShadingOff () |
virtual void | AddShaderVariable (const char *name, int numVars, int *x) |
Provide values to initialize shader variables. More... | |
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) |
Methods to provide to add shader variables from wrappers. More... | |
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) |
Set/Get the texture object to control rendering texture maps. More... | |
vtkTexture * | GetTexture (const char *name) |
void | SetBaseColorTexture (vtkTexture *texture) |
Set the base color texture. More... | |
void | SetORMTexture (vtkTexture *texture) |
Set the ORM texture. More... | |
void | SetAnisotropyTexture (vtkTexture *texture) |
Set the anisotropy texture. More... | |
void | SetNormalTexture (vtkTexture *texture) |
Set the normal texture. More... | |
void | SetEmissiveTexture (vtkTexture *texture) |
Set the emissive texture. More... | |
void | SetCoatNormalTexture (vtkTexture *texture) |
Set the coat normal texture. More... | |
void | RemoveTexture (const char *name) |
Remove a texture from the collection. More... | |
void | RemoveAllTextures () |
Remove all the textures. More... | |
int | GetNumberOfTextures () |
Returns the number of textures in this property. More... | |
std::map< std::string, vtkTexture * > & | GetAllTextures () |
Returns all the textures in this property and their names. More... | |
virtual void | ReleaseGraphicsResources (vtkWindow *win) |
Release any graphics resources that are being consumed by this property. More... | |
virtual vtkInformation * | GetInformation () |
Set/Get the information object associated with the Property. More... | |
virtual void | SetInformation (vtkInformation *) |
double | ComputeReflectanceOfBaseLayer () |
For PBR, calculate the reflectance of the base layer depending on the presence of a coat layer. More... | |
![]() | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. More... | |
virtual void | DebugOff () |
Turn debugging output off. More... | |
bool | GetDebug () |
Get the value of the debug flag. More... | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. More... | |
virtual void | Modified () |
Update the modification time for this object. More... | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. More... | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
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 *) |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
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) |
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. More... | |
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) |
Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
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). More... | |
virtual void | Delete () |
Delete a VTK object. More... | |
virtual void | FastDelete () |
Delete a reference to this object. More... | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. More... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). More... | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). More... | |
int | GetReferenceCount () |
Return the current reference count of this object. More... | |
void | SetReferenceCount (int) |
Sets the reference count. More... | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. More... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkProperty * | SafeDownCast (vtkObjectBase *o) |
static vtkProperty * | New () |
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. More... | |
static double | ComputeReflectanceFromIOR (double IORTo, double IORFrom) |
For PBR, calculate the reflectance from the refractive index of ingoing and outgoing interfaces. More... | |
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. More... | |
![]() | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. More... | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
![]() | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
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). More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More... | |
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. More... | |
Protected Types | |
typedef std::map< std::string, vtkTexture * > | MapOfTextures |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkProperty () | |
~vtkProperty () override | |
![]() | |
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. More... | |
void | InternalReleaseFocus () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Static Protected Member Functions | |
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. More... | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
represent surface properties of a geometric object
vtkProperty is an object that represents lighting and other surface properties of a geometric object. The primary properties that can be set are colors (overall, ambient, diffuse, specular, and edge color); specular power; opacity of the object; the representation of the object (points, wireframe, or surface); and the shading method to be used (flat, Gouraud, and Phong). Also, some special graphics features like backface properties can be set and manipulated with this object.
Definition at line 61 of file vtkProperty.h.
typedef vtkObject vtkProperty::Superclass |
Definition at line 64 of file vtkProperty.h.
|
protected |
Definition at line 793 of file vtkProperty.h.
|
protected |
|
overrideprotected |
|
static |
|
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 vtkObjectBase.
Reimplemented in vtkOpenGLProperty, and vtkRIBProperty.
|
static |
|
protectedvirtual |
Reimplemented in vtkOpenGLProperty, and vtkRIBProperty.
vtkProperty* vtkProperty::NewInstance | ( | ) | const |
|
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 vtkObject.
Reimplemented in vtkOpenGLProperty.
|
static |
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.
Backface and frontface culling are off.
void vtkProperty::DeepCopy | ( | vtkProperty * | p | ) |
Assign one property to another.
|
virtual |
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 in vtkOpenGLProperty, and vtkRIBProperty.
|
inlinevirtual |
This method renders the property as a backface property.
TwoSidedLighting must be turned off to see any backface properties. Note that only colors and opacity are used for backface properties. Other properties such as Representation, Culling are specified by the Property.
Reimplemented in vtkOpenGLProperty.
Definition at line 95 of file vtkProperty.h.
|
virtual |
This method is called after the actor has been rendered.
Don't call this directly. This method cleans up any shaders allocated.
Reimplemented in vtkOpenGLProperty.
|
virtual |
Set/Get lighting flag for an object.
Initial value is true.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get rendering of points as spheres.
The size of the sphere in pixels is controlled by the PointSize attribute. Note that half spheres may be rendered instead of spheres.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get rendering of lines as tubes.
The width of the line in pixels is controlled by the LineWidth attribute. May not be supported on every platform and the implementation may be half tubes, or something only tube like in appearance.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set the shading interpolation method for an object.
|
virtual |
|
inline |
Definition at line 144 of file vtkProperty.h.
|
inline |
Definition at line 145 of file vtkProperty.h.
|
inline |
Definition at line 146 of file vtkProperty.h.
|
inline |
Definition at line 147 of file vtkProperty.h.
|
inline |
Return the method of shading as a descriptive character string.
Definition at line 808 of file vtkProperty.h.
|
virtual |
Control the surface geometry representation for the object.
|
virtual |
|
inline |
Definition at line 157 of file vtkProperty.h.
|
inline |
Definition at line 158 of file vtkProperty.h.
|
inline |
Definition at line 159 of file vtkProperty.h.
|
inline |
Return the method of shading as a descriptive character string.
Definition at line 833 of file vtkProperty.h.
|
virtual |
Set the color of the object.
Has the side effect of setting the ambient diffuse and specular colors as well. This is basically a quick overall color setting method.
|
virtual |
double* vtkProperty::GetColor | ( | ) |
void vtkProperty::GetColor | ( | double | rgb[3] | ) |
void vtkProperty::GetColor | ( | double & | r, |
double & | g, | ||
double & | b | ||
) |
|
virtual |
Set/Get the Index Of Refraction of the base layer.
It controls the amount of light reflected at normal incidence (the reflectance F0), depending on the IOR of the upper layer (eg. coat layer, or environment). For example, with a base IOR of 1.5 and an IOR of 1.0 outside (IOR of the air), 4% of the amount of the light is reflected at normal incidence. Notice that modifying this value is only useful for dielectrics materials, as the reflectance for metallic is the albedo. This parameter is only used by PBR Interpolation. Default value is 1.5
|
virtual |
|
virtual |
Set/Get the metallic coefficient.
Usually this value is either 0 or 1 for real material but any value in between is valid. This parameter is only used by PBR Interpolation. Default value is 0.0
|
virtual |
|
virtual |
Set/Get the roughness coefficient.
This value has to be between 0 (glossy) and 1 (rough). A glossy material has reflections and a high specular part. This parameter is only used by PBR Interpolation. Default value is 0.5
|
virtual |
|
virtual |
Set/Get the anisotropy coefficient.
This value controls the anisotropy of the material (0.0 means isotropic) This parameter is only used by PBR Interpolation. Default value is 0.0
|
virtual |
|
virtual |
Set/Get the anisotropy rotation coefficient.
This value controls the rotation of the direction of the anisotropy. This parameter is only used by PBR Interpolation. Default value is 0.0
|
virtual |
|
virtual |
Set/Get the coat layer Index Of Refraction.
This parameter is only used by PBR Interpolation. Default value is 2.0
|
virtual |
|
virtual |
Set/Get the coat layer roughness coefficient.
This value has to be between 0 (glossy) and 1 (rough). This parameter is only used by PBR Interpolation. Default value is 0.0
|
virtual |
|
virtual |
Set/Get the coat layer strength coefficient.
This value affects the strength of the coat layer reflection. This parameter is only used by PBR Interpolation. Default value is 0.0
|
virtual |
|
virtual |
Set/Get the color of the coat layer.
This value is only used by PBR Interpolation. Default value is white [1.0, 1.0, 1.0]
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get the coat layer normal scale coefficient.
This value affects the strength of the normal deviation from the coat normal texture. This parameter is only used by PBR Interpolation. Default value is 1.0
|
virtual |
|
virtual |
Set/Get the normal scale coefficient.
This value affects the strength of the normal deviation from the texture. Default value is 1.0
|
virtual |
|
virtual |
Set/Get the occlusion strength coefficient.
This value affects the strength of the occlusion if a material texture is present. This parameter is only used by PBR Interpolation. Default value is 1.0
|
virtual |
|
virtual |
Set/Get the emissive factor.
This value is multiplied with the emissive color when an emissive texture is present. This parameter is only used by PBR Interpolation. Default value is [1.0, 1.0, 1.0]
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get the edge tint (for metals only).
Set the color at grazing angle (fresnel reflectance). This parameter is only used by PBR Interpolation. Default value is [1.0, 1.0, 1.0]
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get the ambient lighting coefficient.
|
virtual |
|
virtual |
Set/Get the diffuse lighting coefficient.
|
virtual |
|
virtual |
Set/Get the specular lighting coefficient.
|
virtual |
|
virtual |
Set/Get the specular power.
|
virtual |
|
virtual |
Set/Get the object's opacity.
1.0 is totally opaque and 0.0 is completely transparent.
|
virtual |
|
virtual |
Set/Get the ambient surface color.
Not all renderers support separate ambient and diffuse colors. From a physical standpoint it really doesn't make too much sense to have both. For the rendering libraries that don't support both, the diffuse color is used.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get the diffuse surface color.
For PBR Interpolation, DiffuseColor is used as the base color
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get the specular surface color.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Turn on/off the visibility of edges.
On some renderers it is possible to render the edges of geometric primitives separately from the interior.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get the color of primitive edges (if edge visibility is enabled).
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Turn on/off the visibility of vertices.
On some renderers it is possible to render the vertices of geometric primitives separately from the interior.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get the color of primitive vertices (if vertex visibility is enabled).
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get the RGBA color of selection primitives (if a selection is active on the mapper).
Default is red and opaque.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get the selection line width.
Default is 2.
|
virtual |
|
virtual |
Set/Get the selection point size.
Default is 2.
|
virtual |
|
virtual |
Set/Get the width of a Line.
The width is expressed in screen units. This is only implemented for OpenGL. The default is 1.0.
|
virtual |
|
virtual |
Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off).
This is only implemented for OpenGL, not OpenGL2. The default is 0xFFFF.
|
virtual |
|
virtual |
Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated.
This is only implemented for OpenGL, not OpenGL2. The default is 1.
|
virtual |
|
virtual |
Set/Get the diameter of a point.
The size is expressed in screen units. This is only implemented for OpenGL. The default is 1.0.
|
virtual |
|
virtual |
Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
If backface culling is on, polygons facing away from camera are not drawn.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Turn on/off fast culling of polygons based on orientation of normal with respect to camera.
If frontface culling is on, polygons facing towards camera are not drawn.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Returns the name of the material currently loaded, if any.
|
virtual |
|
virtual |
Enable/Disable shading.
When shading is enabled, the Material must be set.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Provide values to initialize shader variables.
Useful to initialize shader variables that change over time (animation, GUI widgets inputs, etc. )
name
- hardware name of the uniform variablenumVars
- number of variables being setx
- values
|
virtual |
|
virtual |
|
inline |
Methods to provide to add shader variables from wrappers.
Definition at line 563 of file vtkProperty.h.
|
inline |
Definition at line 564 of file vtkProperty.h.
|
inline |
Definition at line 565 of file vtkProperty.h.
|
inline |
Definition at line 566 of file vtkProperty.h.
|
inline |
Definition at line 571 of file vtkProperty.h.
|
inline |
Definition at line 576 of file vtkProperty.h.
|
inline |
Definition at line 581 of file vtkProperty.h.
|
inline |
Definition at line 586 of file vtkProperty.h.
|
inline |
Definition at line 591 of file vtkProperty.h.
void vtkProperty::SetTexture | ( | const char * | name, |
vtkTexture * | texture | ||
) |
Set/Get the texture object to control rendering texture maps.
This will be a vtkTexture object. A property does not need to have an associated texture map and multiple properties can share one texture. Textures must be assigned unique names. Note that for texture blending the textures will be rendering is alphabetical order and after any texture defined in the actor. There exists 6 special textures with reserved names: "albedoTex", "materialTex", "normalTex", "emissiveTex", "anisotropyTex" and "coatNormalTex". While these textures can be added with the regular SetTexture method, it is preferred to use the methods SetBaseColorTexture, SetORMTexture, SetNormalTexture, SetEmissiveTexture, SetAnisotropyTexture and SetCoatNormalTex respectively.
vtkTexture* vtkProperty::GetTexture | ( | const char * | name | ) |
|
inline |
Set the base color texture.
Also called albedo, this texture is only used while rendering with PBR interpolation. This is the color of the object. This texture must be in sRGB color space.
Definition at line 622 of file vtkProperty.h.
|
inline |
Set the ORM texture.
This texture contains three RGB independent components corresponding to the Occlusion value, Roughness value and Metallic value respectively. Each texture value is scaled by the Occlusion strength, roughness coefficient and metallic coefficient. This texture must be in linear color space. This is only used by the PBR shading model.
Definition at line 633 of file vtkProperty.h.
|
inline |
Set the anisotropy texture.
This texture contains two independent components corresponding to the anisotropy value and anisotropy rotation. The last component (blue channel) is discarded. The anisotropy value is scaled by the anisotropy coefficient of the material. The anisotropy rotation rotates the direction of the anisotropy (ie. the tangent) around the normal and is not scaled by the anisotropy rotation coefficient. This texture must be in linear color space. This is only used by the PBR shading model.
Definition at line 645 of file vtkProperty.h.
|
inline |
Set the normal texture.
This texture is required for normal mapping. It is valid for both PBR and Phong interpolation. The normal mapping is enabled if this texture is present and both normals and tangents are presents in the vtkPolyData. This texture must be in linear color space.
Definition at line 655 of file vtkProperty.h.
|
inline |
Set the emissive texture.
When present, this RGB texture provides location and color to the shader where the vtkPolyData should emit light. Emited light is scaled by EmissiveFactor. This is only supported by PBR interpolation model. This texture must be in sRGB color space.
Definition at line 664 of file vtkProperty.h.
|
inline |
Set the coat normal texture.
This texture is required for coat normal mapping. It is valid only for PBR interpolation. The coat normal mapping is enabled if this texture is present and both normals and tangents are presents in the vtkPolyData. This texture must be in linear color space.
Definition at line 674 of file vtkProperty.h.
void vtkProperty::RemoveTexture | ( | const char * | name | ) |
Remove a texture from the collection.
void vtkProperty::RemoveAllTextures | ( | ) |
Remove all the textures.
int vtkProperty::GetNumberOfTextures | ( | ) |
Returns the number of textures in this property.
|
inline |
Returns all the textures in this property and their names.
Definition at line 694 of file vtkProperty.h.
|
virtual |
Release any graphics resources that are being consumed by this property.
The parameter window could be used to determine which graphic resources to release.
Reimplemented in vtkOpenGLProperty.
|
virtual |
Set/Get the information object associated with the Property.
|
virtual |
|
static |
For PBR, calculate the reflectance from the refractive index of ingoing and outgoing interfaces.
|
static |
For PBR, calculate the refractive index from the reflectance of the interface and the refractive index of one of both medium.
double vtkProperty::ComputeReflectanceOfBaseLayer | ( | ) |
For PBR, calculate the reflectance of the base layer depending on the presence of a coat layer.
If there is no coat layer, the reflectance is the one at the interface environment - base layer. If a coat layer is present, the reflectance is the one at the interface between the base and the coat layer.
|
staticprotected |
Computes composite color.
Used by GetColor().
|
protected |
Definition at line 747 of file vtkProperty.h.
|
protected |
Definition at line 748 of file vtkProperty.h.
|
protected |
Definition at line 749 of file vtkProperty.h.
|
protected |
Definition at line 750 of file vtkProperty.h.
|
protected |
Definition at line 751 of file vtkProperty.h.
|
protected |
Definition at line 752 of file vtkProperty.h.
|
protected |
Definition at line 753 of file vtkProperty.h.
|
protected |
Definition at line 754 of file vtkProperty.h.
|
protected |
Definition at line 755 of file vtkProperty.h.
|
protected |
Definition at line 756 of file vtkProperty.h.
|
protected |
Definition at line 757 of file vtkProperty.h.
|
protected |
Definition at line 758 of file vtkProperty.h.
|
protected |
Definition at line 759 of file vtkProperty.h.
|
protected |
Definition at line 760 of file vtkProperty.h.
|
protected |
Definition at line 761 of file vtkProperty.h.
|
protected |
Definition at line 762 of file vtkProperty.h.
|
protected |
Definition at line 763 of file vtkProperty.h.
|
protected |
Definition at line 764 of file vtkProperty.h.
|
protected |
Definition at line 765 of file vtkProperty.h.
|
protected |
Definition at line 766 of file vtkProperty.h.
|
protected |
Definition at line 767 of file vtkProperty.h.
|
protected |
Definition at line 768 of file vtkProperty.h.
|
protected |
Definition at line 769 of file vtkProperty.h.
|
protected |
Definition at line 770 of file vtkProperty.h.
|
protected |
Definition at line 771 of file vtkProperty.h.
|
protected |
Definition at line 772 of file vtkProperty.h.
|
protected |
Definition at line 773 of file vtkProperty.h.
|
protected |
Definition at line 774 of file vtkProperty.h.
|
protected |
Definition at line 775 of file vtkProperty.h.
|
protected |
Definition at line 776 of file vtkProperty.h.
|
protected |
Definition at line 777 of file vtkProperty.h.
|
protected |
Definition at line 778 of file vtkProperty.h.
|
protected |
Definition at line 779 of file vtkProperty.h.
|
protected |
Definition at line 780 of file vtkProperty.h.
|
protected |
Definition at line 781 of file vtkProperty.h.
|
protected |
Definition at line 782 of file vtkProperty.h.
|
protected |
Definition at line 783 of file vtkProperty.h.
|
protected |
Definition at line 784 of file vtkProperty.h.
|
protected |
Definition at line 785 of file vtkProperty.h.
|
protected |
Definition at line 786 of file vtkProperty.h.
|
protected |
Definition at line 787 of file vtkProperty.h.
|
protected |
Definition at line 789 of file vtkProperty.h.
|
protected |
Definition at line 791 of file vtkProperty.h.
|
protected |
Definition at line 794 of file vtkProperty.h.
|
protected |
Definition at line 797 of file vtkProperty.h.