Click or drag to resize
SoBumpMappingProperty Class

Note: This API is now obsolete.

Bump mapping property node.

Inheritance Hierarchy

Namespace: OIV.FXViz.Nodes
Assembly: OIV.FxViz (in OIV.FxViz.dll) Version: 9.9.36.0 (9.9.36.0)
Syntax
[ObsoleteAttribute("See documentation for more details")]
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public class SoBumpMappingProperty : SoNode

The SoBumpMappingProperty type exposes the following members.

Constructors
  NameDescription
Public methodSoBumpMappingProperty

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Inherited from SoNode.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount
(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

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.

(Inherited from SoNode.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodStatic memberIsSupported

Indicates if bump mapping is supported by your graphics board.

Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoNode.)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

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.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyisEyeDistanceAttenuation

Eye distance attenuation.

Public propertyisOnlyClosestLightUsed

Indicates if only the closest light (relative to the shape) is used or if all lights are used.

Public propertyisShadowed

Activates/deactivates the lighting of unlit areas.

Public propertynormalMapSpace

Specifies in which space normals in the normal map are expressed.

Public propertytextureFormat

Indicates if the specified bump map texture in SoTexture2 is a height map or a normal map.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

This node defines the current bump mapping properties for all subsequent shapes. However, currently, only SoFaceSet, SoQuadMesh, and SoTriangleStripSet support bump mapping. Two categories of properties can be defined:

  • Texture properties

  • Appearance properties

Texture Properties: The format of the bump map texture stored within the SoTexture2 is given by the textureFormat field. The SoTextureUnit.mappingMethod field indicates if the texture stored within SoTexture2 node is a bump map texture or not. This texture can be a "height map", which is a grayscale texture of height (TextureFormat.HEIGHT_MAP), or a "normal map", which is a 3-component texture of normals (TextureFormat.NORMAL_MAP) with x, y, and z corresponding to the red, green, and blue components respectively.

If the current SoTexture2 node does not contain a 3-component texture, specifying normal map format will have no bump mapping effect.

For a height map format, only the first component of each pixel is used. A height map texture is converted internally to a normal map.

Each normal in the normal map texture can be expressed either in the space of the object called "modeling space" or in the space of the face called "tangent space". The normalMapSpace field allows you to specify the desired coordinate system. The tangent space coordinate system is convenient for applying repetitive wrinkle patterns.

Appearance Properties: OpenGL Gouraud lighting is deactivated when a shape is rendered using the bump mapping technique. A pixel shader and a vertex shader are used instead for computing the lighting contribution per pixel according to the normals stored in the normal map.

Depending on the hardware capabilities, the number of passes (maximum 3) necessary to render a shape also depends on the number of lights, brightness of the shape, and texturing (or not) of the shape. In order to select a compromise between rendering quality and rendering performance, several fields are available:

  • isOnlyClosestLightUsed: Indicates if only the closest light to the shape is used for the lighting computation. true (default) improves performance by decreasing the number of rendering passes.

  • isEyeDistanceAttenuation: Prevents a bumped face from smoothing with camera distance. Setting true reduces performance.

  • isShadowed: Activate/deactivate the self-shadow based on the geometric normal. Setting true reduces performance.

FILE FORMAT/DEFAULT

BumpMappingProperty {
normalMapSpace MODEL_SPACE
isShadowed false
isEyeDistanceAttenuation false
isOnlyClosestLightUsed true
textureFormat NORMAL_MAP
}

ACTION BEHAVIOR

SoGLRenderAction, SoCallbackAction Sets the current properties linked to the bump mapping. Sets: SoBumpMappingPropertyElement

See Also