Package org.web3d.x3d.sai.Shape

Interface PointProperties

All Superinterfaces:

X3DAppearanceChildNode, X3DNode

All Known Implementing Classes:

PointProperties

public interface PointProperties
extends X3DAppearanceChildNode

PointProperties allows precise fine-grained control over the rendering style of PointSet node points inside the same Shape.

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. PointProperties node tooltip: [X3DAppearanceChildNode] PointProperties allows precise fine-grained control over the rendering style of PointSet node points inside the same Shape.

• Hint: DEF/USE copies of a single node can provide a similar "look + feel" style for related shapes in a scene.
• Hint: When an X3DTextureNode is defined in the same Appearance instance as PointProperties node, the points of a PointSet shall be displayed as point sprites using the given texture(s).
• Warning: requires X3D profile='Full' or else include <component name='Shape' level='5'/>

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

See Also:

• SAI Java Specification
• X3D Abstract Specification: PointProperties
• X3D Tooltips: PointProperties
• X3D Scene Authoring Hints

Method Summary

Modifier and Type	Method	Description
float[]	getAttenuation()	Provide array of 3-tuple float results from inputOutput SFVec3f field named attenuation.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
float	getPointSizeMaxValue()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named pointSizeMaxValue.
float	getPointSizeMinValue()	Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named pointSizeMinValue.
float	getPointSizeScaleFactor()	Provide float value within allowed range of [1,infinity) from inputOutput SFFloat field named pointSizeScaleFactor.
PointProperties	setAttenuation(float[] newValue)	Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named attenuation.
PointProperties	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
PointProperties	setPointSizeMaxValue(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named pointSizeMaxValue.
PointProperties	setPointSizeMinValue(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named pointSizeMinValue.
PointProperties	setPointSizeScaleFactor(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named pointSizeScaleFactor.

Method Details

getAttenuation

float[] getAttenuation()

Provide array of 3-tuple float results from inputOutput SFVec3f field named attenuation.

Tooltip: [0,+infinity) attenuation array values [a, b, c] are set to default values if undefined. Together these parameters define attenuation factor 1/(a + b×r + c×r^2) where r is the distance from observer position (current viewpoint) to each point.

• Hint: nominal point size is multiplied by attenuation factor and then clipped to a minimum value of pointSizeMinValue × minimum renderable point size, then clipped to maximum size of pointSizeMaxValue × minimum renderable point size.

Returns:

value of attenuation field

setAttenuation

PointProperties setAttenuation(float[] newValue)

Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named attenuation.

Tooltip: [0,+infinity) attenuation array values [a, b, c] are set to default values if undefined. Together these parameters define attenuation factor 1/(a + b×r + c×r^2) where r is the distance from observer position (current viewpoint) to each point.

• Hint: nominal point size is multiplied by attenuation factor and then clipped to a minimum value of pointSizeMinValue × minimum renderable point size, then clipped to maximum size of pointSizeMaxValue × minimum renderable point size.

Parameters:

newValue - is new value for the attenuation field.

Returns:

PointProperties - 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 interface X3DAppearanceChildNode

Specified by:

getMetadata in interface X3DNode

Returns:

value of metadata field

See Also:

• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

PointProperties 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.

• 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 interface X3DAppearanceChildNode

Specified by:

setMetadata in interface X3DNode

Parameters:

newValue - is new value for the metadata field.

Returns:

PointProperties - 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

getPointSizeMaxValue

float getPointSizeMaxValue()

Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named pointSizeMaxValue.

Tooltip: [0,+infinity) pointSizeMaxValue is maximum allowed scaling factor on nominal browser point scaling.

• Warning: maintain pointSizeMinValue <= pointSizeMaxValue.

Returns:

value of pointSizeMaxValue field

setPointSizeMaxValue

PointProperties setPointSizeMaxValue(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named pointSizeMaxValue.

Tooltip: [0,+infinity) pointSizeMaxValue is maximum allowed scaling factor on nominal browser point scaling.

• Warning: maintain pointSizeMinValue <= pointSizeMaxValue.

Parameters:

newValue - is new value for the pointSizeMaxValue field.

Returns:

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

getPointSizeMinValue

float getPointSizeMinValue()

Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named pointSizeMinValue.

Tooltip: [0,+infinity) pointSizeMinValue is minimum allowed scaling factor on nominal browser point scaling.

• Warning: maintain pointSizeMinValue <= pointSizeMaxValue.

Returns:

value of pointSizeMinValue field

setPointSizeMinValue

PointProperties setPointSizeMinValue(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named pointSizeMinValue.

Tooltip: [0,+infinity) pointSizeMinValue is minimum allowed scaling factor on nominal browser point scaling.

• Warning: maintain pointSizeMinValue <= pointSizeMaxValue.

Parameters:

newValue - is new value for the pointSizeMinValue field.

Returns:

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

getPointSizeScaleFactor

float getPointSizeScaleFactor()

Provide float value within allowed range of [1,infinity) from inputOutput SFFloat field named pointSizeScaleFactor.

Tooltip: [1,+infinity) Nominal rendered point size is a browser-dependent minimum renderable point size, which is then multiplied by an additional pointSizeScaleFactor (which is greater than or equal to 1).

• Hint: additional sizing modifications are determined by pointSizeMinValue, pointSizeMaxValue, and attenuation array.

Returns:

value of pointSizeScaleFactor field

setPointSizeScaleFactor

PointProperties setPointSizeScaleFactor(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named pointSizeScaleFactor.

Tooltip: [1,+infinity) Nominal rendered point size is a browser-dependent minimum renderable point size, which is then multiplied by an additional pointSizeScaleFactor (which is greater than or equal to 1).

• Hint: additional sizing modifications are determined by pointSizeMinValue, pointSizeMaxValue, and attenuation array.

Parameters:

newValue - is new value for the pointSizeScaleFactor field.

Returns:

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