Class ProtoDeclareObject

    • Field Detail

      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: ProtoDeclare.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the ProtoDeclare element: Core
        See Also:
        Constant Field Values
      • LEVEL

        public static final int LEVEL
        Integer constant LEVEL provides default X3D Core component level for this element: 2
        See Also:
        Constant Field Values
      • APPINFO_DEFAULT_VALUE

        public static final java.lang.String APPINFO_DEFAULT_VALUE
        SFString field named appinfo has default value equal to an empty string.
        See Also:
        Constant Field Values
      • DOCUMENTATION_DEFAULT_VALUE

        public static final java.lang.String DOCUMENTATION_DEFAULT_VALUE
        SFString field named documentation has default value equal to an empty string.
        See Also:
        Constant Field Values
      • NAME_DEFAULT_VALUE

        public static final java.lang.String NAME_DEFAULT_VALUE
        SFString field named name has default value equal to an empty string.
        See Also:
        Constant Field Values
      • PROTOBODY_DEFAULT_VALUE

        public static final ProtoBodyObject PROTOBODY_DEFAULT_VALUE
        SFNode field named ProtoBody has default value null (Java syntax) or NULL (XML syntax).
      • PROTOINTERFACE_DEFAULT_VALUE

        public static final ProtoInterfaceObject PROTOINTERFACE_DEFAULT_VALUE
        SFNode field named ProtoInterface has default value null (Java syntax) or NULL (XML syntax).
    • Constructor Detail

      • ProtoDeclareObject

        public ProtoDeclareObject()
        Constructor for ProtoDeclareObject to initialize member variables with default values.
      • ProtoDeclareObject

        public ProtoDeclareObject​(java.lang.String prototypeName)
        Utility constructor that assigns ProtoDeclareObject name after initializing member variables with default values.
        Parameters:
        prototypeName - initial name for this ProtoDeclareObject statement
    • Method Detail

      • getElementName

        public final java.lang.String getElementName()
        Provides name of this element: ProtoDeclare
        Specified by:
        getElementName in class X3DConcreteElement
        Returns:
        name of this element
      • getComponent

        public final java.lang.String getComponent()
        Defines X3D component for the ProtoDeclare element: Core
        Specified by:
        getComponent in class X3DConcreteElement
        Returns:
        X3D component for this element
      • getComponentLevel

        public final int getComponentLevel()
        Provides default X3D component level for this element: 2
        Specified by:
        getComponentLevel in class X3DConcreteElement
        Returns:
        default X3D component level for this element
      • getFieldType

        public java.lang.String getFieldType​(java.lang.String fieldName)
        Indicate type corresponding to given fieldName.
        Specified by:
        getFieldType in class X3DConcreteElement
        Parameters:
        fieldName - name of field in this X3D statement
        Returns:
        X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
        See Also:
        ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
      • getAccessType

        public java.lang.String getAccessType​(java.lang.String fieldName)
        Indicate accessType corresponding to given fieldName.
        Specified by:
        getAccessType in class X3DConcreteElement
        Parameters:
        fieldName - name of field in this X3D statement
        Returns:
        X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
        See Also:
        ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
      • initialize

        public final void initialize()
        Initialize all member variables to default values.
        Overrides:
        initialize in class X3DConcreteStatement
      • getAppinfo

        public java.lang.String getAppinfo()
        Provide String value from inputOutput SFString field named appinfo.

        Tooltip: Application information to provide simple description usable as a tooltip, similar to XML Schema appinfo tag. *
        Returns:
        value of appinfo field
      • setAppinfo

        public ProtoDeclareObject setAppinfo​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named appinfo.

        Tooltip: Application information to provide simple description usable as a tooltip, similar to XML Schema appinfo tag. *
        Parameters:
        newValue - is new value for the appinfo field.
        Returns:
        ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setAppinfo

        public ProtoDeclareObject setAppinfo​(SFStringObject newValue)
        Assign typed object value to SFString appinfo field, similar to setAppinfo(String).
        Parameters:
        newValue - is new value for the appinfo field.
        Returns:
        ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getDocumentation

        public java.lang.String getDocumentation()
        Provide String value from inputOutput SFString field named documentation.

        Tooltip: Documentation url for further information, similar to XML Schema documentation tag. *
        Returns:
        value of documentation field
      • setDocumentation

        public ProtoDeclareObject setDocumentation​(java.lang.String newValue)
        Accessor method to assign String value to inputOutput SFString field named documentation.

        Tooltip: Documentation url for further information, similar to XML Schema documentation tag. *
        Parameters:
        newValue - is new value for the documentation field.
        Returns:
        ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setDocumentation

        public ProtoDeclareObject setDocumentation​(SFStringObject newValue)
        Assign typed object value to SFString documentation field, similar to setDocumentation(String).
        Parameters:
        newValue - is new value for the documentation field.
        Returns:
        ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • setName

        public ProtoDeclareObject setName​(SFStringObject newValue)
        Assign typed object value to SFString name field, similar to setName(String).
        Parameters:
        newValue - is new value for the name field.
        Returns:
        ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • getProtoBody

        public ProtoBodyObject getProtoBody()
        Provide ProtoBodyObject instance (using a properly typed node) from inputOutput SFNode field ProtoBody.

        Tooltip: Include one ProtoBody statements after the ProtoInterface statement. *
        Returns:
        value of ProtoBody field
      • setProtoBody

        public ProtoDeclareObject setProtoBody​(ProtoBodyObject newValue)
        Accessor method to assign ProtoBodyObject instance (using a properly typed node) to inputOutput SFNode field ProtoBody.

        Tooltip: Include one ProtoBody statements after the ProtoInterface statement. *
        Parameters:
        newValue - is new value for the ProtoBody field.
        Returns:
        ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      • clearProtoBody

        public ProtoDeclareObject clearProtoBody()
        Utility method to clear SFNode value of ProtoBody field.
        Returns:
        ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasProtoBody

        public boolean hasProtoBody()
        Indicate whether an object is available for inputOutput SFNode field ProtoBody.
        Returns:
        whether a concrete statement or CommentsBlock is available.
        See Also:
        getProtoBody()
      • clearProtoInterface

        public ProtoDeclareObject clearProtoInterface()
        Utility method to clear SFNode value of ProtoInterface field.
        Returns:
        ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • hasProtoInterface

        public boolean hasProtoInterface()
        Indicate whether an object is available for inputOutput SFNode field ProtoInterface.
        Returns:
        whether a concrete statement or CommentsBlock is available.
        See Also:
        getProtoInterface()
      • findFieldByName

        public fieldObject findFieldByName​(java.lang.String fieldName)
        Find contained field statement by name, if present in contained ProtoInterface.
        Parameters:
        fieldName - is name attribute for field of interest
        Returns:
        fieldObject reference of interest, null otherwise
      • hasField

        public boolean hasField​(java.lang.String fieldName)
        Determine if field statement is present in contained ProtoInterface.
        Parameters:
        fieldName - is name attribute for field of interest
        Returns:
        whether field is found
      • addComments

        public ProtoDeclareObject addComments​(java.lang.String newComment)
        Add comment as String to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComment - initial value
        Returns:
        ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

        public ProtoDeclareObject addComments​(java.lang.String[] newComments)
        Add comments as String[] array to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newComments - array of comments
        Returns:
        ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • addComments

        public ProtoDeclareObject addComments​(CommentsBlock newCommentsBlock)
        Add CommentsBlock to contained commentsList.
        Specified by:
        addComments in class X3DConcreteElement
        Parameters:
        newCommentsBlock - block of comments to add
        Returns:
        ProtoDeclareObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
      • findElementByNameValue

        public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
        Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

        Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

        Warning: more than one element may be found that has the same name, this method does not handle that case.
        Specified by:
        findElementByNameValue in class X3DConcreteElement
        Parameters:
        nameValue - is value of the name field being searched for in this element and child elements(if any)
        Returns:
        object reference to found element, null otherwise
        See Also:
        findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • findElementByNameValue

        public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue,
                                                         java.lang.String elementName)
        Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

        Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

        Warning: more than one element may be found that has the same name, this method does not handle that case.
        Specified by:
        findElementByNameValue in class X3DConcreteElement
        Parameters:
        nameValue - is value of the name field being searched for in this element and child elements(if any)
        elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
        Returns:
        object reference to found element, null otherwise
        See Also:
        findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
      • hasElementByNameValue

        public boolean hasElementByNameValue​(java.lang.String nameValue,
                                             java.lang.String elementName)
        Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
        Parameters:
        nameValue - is value of the name field being searched for in this element and child elements(if any)
        elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
        Returns:
        whether node is found
        See Also:
        findElementByNameValue(String, String)
      • hasNodeByDEF

        public boolean hasNodeByDEF​(java.lang.String DEFvalue)
        Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
        Parameters:
        DEFvalue - is value of the name field being searched for in this element and child elements(if any)
        Returns:
        whether node is found
        See Also:
        findNodeByDEF(String)
      • validate

        public java.lang.String validate()
        Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
        Specified by:
        validate in class X3DConcreteElement
        Returns:
        validation results (if any)
      • setDEF

        @Deprecated
        public ProtoDeclareObject setDEF​(java.lang.String newValue)
        Deprecated.
        DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
        Parameters:
        newValue - ignored
        Returns:
        unmodified object, this method is deprecated and has no effect
      • setUSE

        @Deprecated
        public ProtoDeclareObject setUSE​(java.lang.String newValue)
        Deprecated.
        DO NOT USE: operation ignored since no such field exists for this element. This method has no effect, a stub method is necessary to implement X3DChildNode interface.
        Parameters:
        newValue - ignored
        Returns:
        unmodified object, this method is deprecated and has no effect
      • setCssClass

        @Deprecated
        public ProtoDeclareObject setCssClass​(java.lang.String newValue)
        Deprecated.