Interface TextureCoordinateGenerator
- All Superinterfaces:
X3DGeometricPropertyNode
,X3DNode
,X3DSingleTextureCoordinateNode
,X3DTextureCoordinateNode
- All Known Implementing Classes:
TextureCoordinateGenerator
TextureCoordinateGenerator computes 2D (s,t) texture-coordinate points, used by vertex-based geometry nodes (such as IndexedFaceSet or ElevationGrid) to map textures to vertices (and patches to NURBS surfaces).
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the
org.web3d.x3d.jsail
classes.
TextureCoordinateGenerator node tooltip: [X3DSingleTextureCoordinateNode] TextureCoordinateGenerator computes 2D (s,t) texture-coordinate points, used by vertex-based geometry nodes (such as IndexedFaceSet or ElevationGrid) to map textures to vertices (and patches to NURBS surfaces).
- Hint: add Shape and then polgyonal/planar geometry before adding TextureCoordinateGenerator.
- Hint: Texture mapping https://en.wikipedia.org/wiki/Texture_mapping
- Hint: X3D Texturing component Figure 18.1, Texture map coordinate system https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#f-TextureMapCoordSystem
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionProvide String value from inputOutput SFString field named mapping.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.getMode()
Provide String enumeration value (baseType xs:NMTOKEN) ["SPHERE" | "CAMERASPACENORMAL" | "CAMERASPACEPOSITION" | "CAMERASPACEREFLECTIONVECTOR" | "SPHERE-LOCAL" | "COORD" | "COORD-EYE" | "NOISE" | "NOISE-EYE" | "SPHERE-REFLECT" | "SPHERE-REFLECT-LOCAL"] from inputOutput SFString field named mode.float[]
Provide array of float results from inputOutput MFFloat field named parameter.setMapping
(String newValue) Accessor method to assign String value to inputOutput SFString field named mapping.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.Accessor method to assign String enumeration value ("SPHERE" | "CAMERASPACENORMAL" | "CAMERASPACEPOSITION" | "CAMERASPACEREFLECTIONVECTOR" | "SPHERE-LOCAL" | "COORD" | "COORD-EYE" | "NOISE" | "NOISE-EYE" | "SPHERE-REFLECT" | "SPHERE-REFLECT-LOCAL") to inputOutput SFString field named mode.setParameter
(float[] newValue) Accessor method to assign float array to inputOutput MFFloat field named parameter.
-
Method Details
-
getMapping
String getMapping()Provide String value from inputOutput SFString field named mapping.
Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.- Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator https://savage.nps.edu/X3dValidator
- Specified by:
getMapping
in interfaceX3DSingleTextureCoordinateNode
- Returns:
- value of mapping field
-
setMapping
Accessor method to assign String value to inputOutput SFString field named mapping.
Tooltip: The mapping label identifies which texture coordinates and transformations are used to compute texture effects from corresponding geometry on a given material.- Hint: TODO support planned to perform multiple-node mapping validation checks using X3D Schematron or X3D Validator https://savage.nps.edu/X3dValidator
- Specified by:
setMapping
in interfaceX3DSingleTextureCoordinateNode
- Parameters:
newValue
- is new value for the mapping field.- Returns:
TextureCoordinateGenerator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
X3DMetadataObject getMetadata()Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
- Specified by:
getMetadata
in interfaceX3DGeometricPropertyNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DSingleTextureCoordinateNode
- Specified by:
getMetadata
in interfaceX3DTextureCoordinateNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
- Specified by:
setMetadata
in interfaceX3DGeometricPropertyNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DSingleTextureCoordinateNode
- Specified by:
setMetadata
in interfaceX3DTextureCoordinateNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
TextureCoordinateGenerator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getMode
String getMode()Provide String enumeration value (baseType xs:NMTOKEN) ["SPHERE" | "CAMERASPACENORMAL" | "CAMERASPACEPOSITION" | "CAMERASPACEREFLECTIONVECTOR" | "SPHERE-LOCAL" | "COORD" | "COORD-EYE" | "NOISE" | "NOISE-EYE" | "SPHERE-REFLECT" | "SPHERE-REFLECT-LOCAL"] from inputOutput SFString field named mode.
Tooltip: parameter field defines the algorithm used to compute texture coordinates.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.6 Texture coordinate generation modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-Texturecoordgeneration for further details.
- Returns:
- value of mode field
-
setMode
Accessor method to assign String enumeration value ("SPHERE" | "CAMERASPACENORMAL" | "CAMERASPACEPOSITION" | "CAMERASPACEREFLECTIONVECTOR" | "SPHERE-LOCAL" | "COORD" | "COORD-EYE" | "NOISE" | "NOISE-EYE" | "SPHERE-REFLECT" | "SPHERE-REFLECT-LOCAL") to inputOutput SFString field named mode.
Tooltip: parameter field defines the algorithm used to compute texture coordinates.- Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
- Hint: X3D Architecture Table 18.6 Texture coordinate generation modes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/texturing.html#t-Texturecoordgeneration for further details.
- Parameters:
newValue
- is new value for the mode field.- Returns:
TextureCoordinateGenerator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getParameter
float[] getParameter()Provide array of float results from inputOutput MFFloat field named parameter.
Tooltip: parameter array contains scale and translation (x y z) values for Perlin NOISE mode, parameter[0] contains index of refraction for SPHERE-REFLECT mode, parameter[0] contains index of refraction and parameter[1 to 3] contains the eye point in local coordinates for SPHERE-REFLECT-LOCAL mode. *- Returns:
- value of parameter field
-
setParameter
Accessor method to assign float array to inputOutput MFFloat field named parameter.
Tooltip: parameter array contains scale and translation (x y z) values for Perlin NOISE mode, parameter[0] contains index of refraction for SPHERE-REFLECT mode, parameter[0] contains index of refraction and parameter[1 to 3] contains the eye point in local coordinates for SPHERE-REFLECT-LOCAL mode. *- Parameters:
newValue
- is new value for the parameter field.- Returns:
TextureCoordinateGenerator
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-