Interface FloatVertexAttribute

All Superinterfaces:
X3DGeometricPropertyNode, X3DNode, X3DVertexAttributeNode
All Known Implementing Classes:
FloatVertexAttribute
public interface FloatVertexAttribute extends X3DVertexAttributeNode
FloatVertexAttribute defines a set of per-vertex single-precision floating-point attributes.

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. FloatVertexAttribute node tooltip: (X3D version 3.1 or later) [X3DVertexAttributeNode] FloatVertexAttribute defines a set of per-vertex single-precision floating-point attributes. *


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 Type
    Method
    Description
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    String
    getName()
    Provide String value from initializeOnly xs:NMTOKEN field named name.
    int
    getNumComponents()
    Provide int value within allowed range of [1,4] from initializeOnly SFInt32 field named numComponents.
    float[]
    getValue()
    Provide array of float results from inputOutput MFFloat field named value.
    FloatVertexAttribute
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    FloatVertexAttribute
    setName(String newValue)
    Accessor method to assign String value to initializeOnly xs:NMTOKEN field named name.
    FloatVertexAttribute
    setNumComponents(int newValue)
    Accessor method to assign int value to initializeOnly SFInt32 field named numComponents.
    FloatVertexAttribute
    setValue(float[] newValue)
    Accessor method to assign float array to inputOutput MFFloat field named value.

  • Method Details

    • 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.
      Specified by:
      getMetadata in interface X3DGeometricPropertyNode
      Specified by:
      getMetadata in interface X3DNode
      Specified by:
      getMetadata in interface X3DVertexAttributeNode
      Returns:
      value of metadata field
      See Also:

    • setMetadata

      FloatVertexAttribute setMetadata(X3DMetadataObject newValue)
      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.
      Specified by:
      setMetadata in interface X3DGeometricPropertyNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DVertexAttributeNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      FloatVertexAttribute - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getName

      String getName()
      Provide String value from initializeOnly xs:NMTOKEN field named name.

      Tooltip: Required name for this particular VertexAttribute instance.
      Specified by:
      getName in interface X3DVertexAttributeNode
      Returns:
      value of name field

    • setName

      FloatVertexAttribute setName(String newValue)
      Accessor method to assign String value to initializeOnly xs:NMTOKEN field named name.

      Tooltip: Required name for this particular VertexAttribute instance.
      Specified by:
      setName in interface X3DVertexAttributeNode
      Parameters:
      newValue - is new value for the name field.
      Returns:
      FloatVertexAttribute - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getNumComponents

      int getNumComponents()
      Provide int value within allowed range of [1,4] from initializeOnly SFInt32 field named numComponents.

      Tooltip: numComponents specifies how many consecutive floating-point values should be grouped together per vertex.
      • Hint: the length of the value field shall be a multiple of numComponents.
      Returns:
      value of numComponents field

    • setNumComponents

      FloatVertexAttribute setNumComponents(int newValue)
      Accessor method to assign int value to initializeOnly SFInt32 field named numComponents.

      Tooltip: numComponents specifies how many consecutive floating-point values should be grouped together per vertex.
      • Hint: the length of the value field shall be a multiple of numComponents.
      Parameters:
      newValue - is new value for the numComponents field.
      Returns:
      FloatVertexAttribute - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getValue

      float[] getValue()
      Provide array of float results from inputOutput MFFloat field named value.

      Tooltip: value specifies an arbitrary collection of floating-point values that will be passed to the shader as per-vertex information.
      • Hint: the length of the value field shall be a multiple of numComponents.
      Returns:
      value of value field

    • setValue

      FloatVertexAttribute setValue(float[] newValue)
      Accessor method to assign float array to inputOutput MFFloat field named value.

      Tooltip: value specifies an arbitrary collection of floating-point values that will be passed to the shader as per-vertex information.
      • Hint: the length of the value field shall be a multiple of numComponents.
      Parameters:
      newValue - is new value for the value field.
      Returns:
      FloatVertexAttribute - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).