| SoPhysicalMaterial Class |
Physically based surface material definition node.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoPhysicalMaterial
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.0.0 (2024.2.0)
SyntaxThe SoPhysicalMaterial type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoPhysicalMaterial | Initializes a new instance of the SoPhysicalMaterial class |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Overrides SoNodeCallback(SoCallbackAction).) |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Overrides SoNodeDoAction(SoAction).) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | (Inherited from SoNode.) |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Inherited from SoNode.) |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | (Inherited from SoNode.) |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Overrides SoNodeGLRender(SoGLRenderAction).) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoNode.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsBoundingBoxIgnoring | This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Inherited from SoNode.) |
| RayPick | (Overrides SoNodeRayPick(SoRayPickAction).) |
| Search | (Inherited from SoNode.) |
| Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Overrides SoNodeWrite(SoWriteAction).) |
Properties| Name | Description | |
|---|---|---|
 | baseColor | Base color of the surface. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| metallic | Metallic coefficient of the surface. |
| roughness | Roughness coefficient of the surface. |
| specular | Specular coefficient of the surface. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksThis node defines the current physically based surface material properties for all subsequent shapes. The OIV.Inventor.Nodes.SoPhysicalMaterial.baseColor, OIV.Inventor.Nodes.SoPhysicalMaterial.specular, OIV.Inventor.Nodes.SoPhysicalMaterial.roughness, and OIV.Inventor.Nodes.SoPhysicalMaterial.metallic fields are taken into account during the rendering when the SoLighModel.model field is set to OIV.Inventor.Nodes.SoLightModel.Models.PHYSICALLY_BASED.
As described here, other property nodes can override the OIV.Inventor.Nodes.SoPhysicalMaterial.baseColor of this class.
If lighting is turned off (OIV.Inventor.Nodes.SoLightModel set to BASE_COLOR), only the baseColor color is used to render geometry.
# Override material
To force all geometry following/below this node to use specific color and transparency values, call the OIV.Inventor.Nodes.SoPhysicalMaterial.SetOverride(System.Boolean) method with true. Overriding the base color overrides the color and transparency values in other nodes including OIV.Inventor.Nodes.SoPackedColor and OIV.Inventor.Nodes.SoVertexProperty. This can be useful, for example, to highlight a selected object.
It is also possible to override only a subset of the OIV.Inventor.Nodes.SoPhysicalMaterial fields. If, for example, you only want to override the base color, but not the other values, call setIgnored(true) on the fields that you do not want to override.
# VolumeViz shapes
For scalar (non-RGBA) volumes, the color and alpha value of a voxel is affected by two nodes. OIV.Inventor.Nodes.SoPhysicalMaterial's baseColor field specifies the "base" color and alpha values for all voxels. OIV.LDM.Nodes.SoTransferFunction specifies color and alpha values based on the voxel value. The final voxel color and alpha (before lighting and other effects) is computed by multiplying these two color and alpha values. The default material is (0.8, 0.8, 0.8, 1) (fully opaque gray). The 0.8 value for R, G and B allows lighting to increase the brightness of the voxel. For slice rendering without lighting, the application may want to set the material to 1, 1, 1, 1 so that only the OIV.LDM.Nodes.SoTransferFunction affects the voxel color and alpha. Effectively the alpha value of baseColor (aka transparency) is a "global" multiplier that can increase or decrease the transparency of all voxels in the volume.
FILE FORMAT/DEFAULT
PhysicalMaterial {
| baseColor | 0.8 0.8 0.8 1 |
| specular | 0 |
| roughness | 0.8 |
| metallic | 0 |
ACTION BEHAVIOR
OIV.Inventor.Actions.SoGLRenderAction, OIV.Inventor.Actions.SoCallbackAction Sets the base color, the specular coefficient, the roughness coefficient and the metallic coefficient of the current physically based material. Sets: OIV.Inventor.Elements.SoMaterialElement
See Also