org.web3d.x3d.sai.Rendering

Interface Normal

All Superinterfaces:

X3DGeometricPropertyNode, X3DNode, X3DNormalNode

All Known Implementing Classes:

NormalObject

public interface Normal
extends X3DNormalNode

Abstract node interface, defined by X3D specification to support X3D Java interoperability.

X3D node tooltip: [X3DNormalNode] Normal defines a set of 3D surface-normal vectors that apply either to a sibling Coordinate|CoordinateDouble node, or else to a parent ElevationGrid node. Normal values are perpendicular directions that are used per-polygon or per-vertex when computing lighting and shading.

• Hint: Normal values are typically only calculated or applied once, during initial loading of model geometry.
• Hint: custom Normal values can produce special effects.
• Hint: if no child Normal node is provided, the X3D browser shall automatically generate normals, using creaseAngle to determine smoothed shading across shared vertices.
• Hint: computation of normal values is performed quite quickly on modern 3D graphics hardware, often with no perceptible delay.
• Warning: adding normal values to a model might significantly increase file size. Testing can help determine proper tradeoffs between file size, network transmission delays and initial rendering speed.

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

SAI Java Specification: TODO, X3D Abstract Specification: Normal, X3D Tooltips: Normal, X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method and Description
X3DMetadataObject	getMetadata() Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float[]	getVector() Provide array of 3-tuple float results within allowed range of [-1,1] from inputOutput MFVec3f field named vector.
Normal	setCssClass(java.lang.String newValue) Assign String value to inputOutput SFString field named class.
Normal	setDEF(java.lang.String newValue) Assign String value to inputOutput SFString field named DEF.
Normal	setMetadata(X3DMetadataObject newValue) Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Normal	setUSE(java.lang.String newValue) Assign String value to inputOutput SFString field named USE.
Normal	setVector(float[] newValue) Assign 3-tuple float array within allowed range of [-1,1] to inputOutput MFVec3f field named vector.

Method Detail

getMetadata

X3DMetadataObject getMetadata()

Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

Specified by:

getMetadata in interface X3DGeometricPropertyNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface X3DNormalNode

Returns:

value of metadata field

See Also:

X3D Scene Authoring Hints: Metadata Nodes

setMetadata

Normal setMetadata(X3DMetadataObject newValue)

Assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

Specified by:

setMetadata in interface X3DGeometricPropertyNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface X3DNormalNode

Parameters:

newValue - is new value for the metadata field.

Returns:

Normal - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

X3D Scene Authoring Hints: Metadata Nodes

getVector

float[] getVector()

Provide array of 3-tuple float results within allowed range of [-1,1] from inputOutput MFVec3f field named vector.

Tooltip: set of unit-length normal vectors, corresponding to indexed polygons or vertices.

• Warning: unit length means a magnitude of 1.0, so normal values of (0,0,0) are invalid.

Returns:

value of vector field

setVector

Normal setVector(float[] newValue)

Assign 3-tuple float array within allowed range of [-1,1] to inputOutput MFVec3f field named vector.

Tooltip: set of unit-length normal vectors, corresponding to indexed polygons or vertices. Warning: unit length means a magnitude of 1.0, so normal values of (0,0,0) are invalid.

Parameters:

newValue - is new value for the vector field.

Returns:

Normal - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

Normal setDEF(java.lang.String newValue)

Assign String value to inputOutput SFString field named DEF.

Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes. Hint: descriptive DEF names improve clarity and help document a model. Hint: well-defined names can simplify design and debugging through improved author understanding. Hint: X3D Scene Authoring Hints, Naming Conventions http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Note that setting the DEF value clears the USE value.

Specified by:

setDEF in interface X3DGeometricPropertyNode

Specified by:

setDEF in interface X3DNode

Specified by:

setDEF in interface X3DNormalNode

Parameters:

newValue - is new value for the DEF field.

Returns:

Normal - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

Normal setUSE(java.lang.String newValue)

Assign String value to inputOutput SFString field named USE.

Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value). Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance. Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute. Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.

Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.

Specified by:

setUSE in interface X3DGeometricPropertyNode

Specified by:

setUSE in interface X3DNode

Specified by:

setUSE in interface X3DNormalNode

Parameters:

newValue - is new value for the USE field.

Returns:

Normal - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setCssClass

Normal setCssClass(java.lang.String newValue)

Assign String value to inputOutput SFString field named class.

Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets. Warning: currently the class attribute is only supported in XML encoding of X3D scenes. Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS

Specified by:

setCssClass in interface X3DGeometricPropertyNode

Specified by:

setCssClass in interface X3DNode

Specified by:

setCssClass in interface X3DNormalNode

Parameters:

newValue - is new value for the class field.

Returns:

Normal - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).