Menu
The Background leaf node defines a solid background color and a background image that are used to fill the window at the beginning of each new frame. The background image may be null. It optionally allows background geometry---which is pre-tessellated onto a unit sphere and is drawn at infinity---to be referenced. It also specifies an application region in which this background is active. A Background node is active when its application region intersects the ViewPlatform's activation volume. If multiple Background nodes are active, the Background node that is 'closest' to the eye will be used. If no Background nodes are active, then the window is cleared to black.
The set of nodes that can be added to a BranchGroup associated with a Background node is limited. All Group nodes except ViewSpecificGroup are legal in a background geometry branch graph. The only Leaf nodes that are legal are Shape3D (except OrientedShape3D), Morph, Light, and Fog. The presence of any other Leaf node, including OrientedShape3D, or of a ViewSpecificGroup node will cause an IllegalSceneGraphException to be thrown. Note that Link nodes are not allowed; a background geometry branch graph must not reference shared subgraphs. NodeComponent objects can be shared between background branches and ordinary (non-background) branches or among different background branches, however.
Light and Fog nodes in a background geometry branch graph do not affect nodes outside of the background geometry branch graph, and vice versa. Light and Fog nodes that appear in a background geometry branch graph must not be hierarchically scoped to any group node outside of that background geometry branch graph. Conversely, Light and Fog nodes that appear outside of a particular background geometry branch graph must not be hierarchically scoped to any group node in that background geometry branch graph. Any attempt to do so will be ignored.
Make something awesome. Introduction and background 1.1 Industry 4.0 The concept of Industry 4.0 (i4.0), synonymous with the fourth industrial revolution, appeared as early as 2011 at the Hanover Messe (trade fair.
The influencing bounds of any Light or Fog node in a background geometry branch graph is effectively infinite (meaning that all lights can affect all geometry objects nodes within the background geometry graph, and that an arbitrary fog is selected). An application wishing to limit the scope of a Light or Fog node must use hierarchical scoping.
Picking and collision is ignored for nodes inside a background geometry branch graph.
Field Summary | |
---|---|
static int | ALLOW_APPLICATION_BOUNDS_READ Specifies that the Background allows read access to its application bounds and bounding leaf at runtime. |
static int | ALLOW_APPLICATION_BOUNDS_WRITE Specifies that the Background allows write access to its application bounds and bounding leaf at runtime. |
static int | ALLOW_COLOR_READ Specifies that the Background allows read access to its color at runtime. |
static int | ALLOW_COLOR_WRITE Specifies that the Background allows write access to its color at runtime. |
static int | ALLOW_GEOMETRY_READ Specifies that the Background allows read access to its background geometry at runtime. |
static int | ALLOW_GEOMETRY_WRITE Specifies that the Background allows write access to its background geometry at runtime. |
static int | ALLOW_IMAGE_READ Specifies that the Background allows read access to its image at runtime. |
static int | ALLOW_IMAGE_SCALE_MODE_READ Specifies that the Background allows read access to its image scale mode at runtime. |
static int | ALLOW_IMAGE_SCALE_MODE_WRITE Specifies that the Background allows write access to its image scale mode at runtime. |
static int | ALLOW_IMAGE_WRITE Specifies that the Background allows write access to its image at runtime. |
static int | SCALE_FIT_ALL Indicates that the background image is scaled to fit the window. |
static int | SCALE_FIT_MAX Indicates that the background image is uniformly scaled to fit the window such that the entire window is filled. |
static int | SCALE_FIT_MIN Indicates that the background image is uniformly scaled to fit the window such that the entire image is visible. |
static int | SCALE_NONE Indicates that no scaling of the background image is done. |
static int | SCALE_NONE_CENTER Indicates that the background image is centered in the window and that no scaling of the image is done. |
static int | SCALE_REPEAT Indicates that the background image is tiled to fill the entire window. |
Fields inherited from class javax.media.j3d.Node |
---|
ALLOW_AUTO_COMPUTE_BOUNDS_READ, ALLOW_AUTO_COMPUTE_BOUNDS_WRITE, ALLOW_BOUNDS_READ, ALLOW_BOUNDS_WRITE, ALLOW_COLLIDABLE_READ, ALLOW_COLLIDABLE_WRITE, ALLOW_LOCAL_TO_VWORLD_READ, ALLOW_LOCALE_READ, ALLOW_PARENT_READ, ALLOW_PICKABLE_READ, ALLOW_PICKABLE_WRITE, ENABLE_COLLISION_REPORTING, ENABLE_PICK_REPORTING |
Constructor Summary |
---|
Background() Constructs a Background node with default parameters. |
Background(BranchGroup branch) Constructs a Background node with the specified geometry. |
Background(Color3f color) Constructs a Background node with the specified color. |
Background(float r, float g, float b) Constructs a Background node with the specified color. |
Background(ImageComponent2D image) Constructs a Background node with the specified image. |
Method Summary | |
---|---|
Node | cloneNode(boolean forceDuplicate) Creates a new instance of the node. |
void | duplicateNode(Node originalNode, boolean forceDuplicate) Copies all node information from originalNode into the current node. |
BoundingLeaf | getApplicationBoundingLeaf() Retrieves the Background node's application bounding leaf. |
Bounds | getApplicationBounds() Retrieves the Background node's application bounds. |
void | getColor(Color3f color) Retrieves the background color. |
BranchGroup | getGeometry() Retrieves the background geometry. |
ImageComponent2D | getImage() Retrieves the background image. |
int | getImageScaleMode() Retrieves the current image scale mode. |
void | setApplicationBoundingLeaf(BoundingLeaf region) Set the Background's application region to the specified bounding leaf. |
void | setApplicationBounds(Bounds region) Set the Background's application region to the specified bounds. |
void | setColor(Color3f color) Sets the background color to the specified color. |
void | setColor(float r, float g, float b) Sets the background color to the specified color. |
void | setGeometry(BranchGroup branch) Sets the background geometry to the specified BranchGroup node. |
void | setImage(ImageComponent2D image) Sets the background image to the specified image. |
void | setImageScaleMode(int imageScaleMode) Sets the image scale mode for this Background node. |
void | updateNodeReferences(NodeReferenceTable referenceTable) Callback used to allow a node to check if any scene graph objects referenced by that node have been duplicated via a call to cloneTree . |
Methods inherited from class javax.media.j3d.Node |
---|
cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, cloneTree, getBounds, getBoundsAutoCompute, getCollidable, getLocale, getLocalToVworld, getLocalToVworld, getParent, getPickable, setBounds, setBoundsAutoCompute, setCollidable, setPickable |
Methods inherited from class javax.media.j3d.SceneGraphObject |
---|
clearCapability, clearCapabilityIsFrequent, duplicateSceneGraphObject, getCapability, getCapabilityIsFrequent, getName, getUserData, isCompiled, isLive, setCapability, setCapabilityIsFrequent, setName, setUserData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
ALLOW_APPLICATION_BOUNDS_READ
- Specifies that the Background allows read access to its application bounds and bounding leaf at runtime.
- See Also:
- Constant Field Values
ALLOW_APPLICATION_BOUNDS_WRITE
- Specifies that the Background allows write access to its application bounds and bounding leaf at runtime.
- See Also:
- Constant Field Values
ALLOW_IMAGE_READ
- Specifies that the Background allows read access to its image at runtime.
- See Also:
- Constant Field Values
ALLOW_IMAGE_WRITE
- Specifies that the Background allows write access to its image at runtime.
- See Also:
- Constant Field Values
ALLOW_COLOR_READ
- Specifies that the Background allows read access to its color at runtime.
- See Also:
- Constant Field Values
ALLOW_COLOR_WRITE
- Specifies that the Background allows write access to its color at runtime.
- See Also:
- Constant Field Values
ALLOW_GEOMETRY_READ
- Specifies that the Background allows read access to its background geometry at runtime.
- See Also:
- Constant Field Values
ALLOW_GEOMETRY_WRITE
- Specifies that the Background allows write access to its background geometry at runtime.
- See Also:
- Constant Field Values
ALLOW_IMAGE_SCALE_MODE_READ
- Specifies that the Background allows read access to its image scale mode at runtime.
- Since:
- Java 3D 1.3
- See Also:
- Constant Field Values
ALLOW_IMAGE_SCALE_MODE_WRITE
- Specifies that the Background allows write access to its image scale mode at runtime.
- Since:
- Java 3D 1.3
- See Also:
- Constant Field Values
SCALE_NONE
- Indicates that no scaling of the background image is done. The image will be drawn in its actual size. If the window is smaller than the image, the image will be clipped. If the window is larger than the image, the portion of the window not filled by the image will be filled with the background color. In all cases, the upper left corner of the image is anchored at the upper-left corner of the window. This is the default mode.
- Since:
- Java 3D 1.3
- See Also:
setImageScaleMode(int)
, Constant Field Values
SCALE_FIT_MIN
- Indicates that the background image is uniformly scaled to fit the window such that the entire image is visible. The image is scaled by the smaller of
window.width/image.width
andwindow.height/image.height
. The image will exactly fill either the width or height of the window, but not necessarily both. The portion of the window not filled by the image will be filled with the background color. The upper left corner of the image is anchored at the upper-left corner of the window.- Since:
- Java 3D 1.3
- See Also:
setImageScaleMode(int)
, Constant Field Values
SCALE_FIT_MAX
- Indicates that the background image is uniformly scaled to fit the window such that the entire window is filled. The image is scaled by the larger of
window.width/image.width
andwindow.height/image.height
. The image will entirely fill the window, but may by clipped either in X or Y. The upper left corner of the image is anchored at the upper-left corner of the window.- Since:
- Java 3D 1.3
- See Also:
setImageScaleMode(int)
, Constant Field Values
SCALE_FIT_ALL
- Indicates that the background image is scaled to fit the window. The image is scaled non-uniformly in x and y by
window.width/image.width
and andwindow.height/image.height
, respectively. The image will entirely fill the window.- Since:
- Java 3D 1.3
- See Also:
setImageScaleMode(int)
, Constant Field Values
SCALE_REPEAT
- Indicates that the background image is tiled to fill the entire window. The image is not scaled. The upper left corner of the image is anchored at the upper-left corner of the window.
- Since:
- Java 3D 1.3
- See Also:
setImageScaleMode(int)
, Constant Field Values
SCALE_NONE_CENTER
- Indicates that the background image is centered in the window and that no scaling of the image is done. The image will be drawn in its actual size. If the window is smaller than the image, the image will be clipped. If the window is larger than the image, the portion of the window not filled by the image will be filled with the background color.
- Since:
- Java 3D 1.3
- See Also:
setImageScaleMode(int)
, Constant Field Values
Constructor Detail |
---|
Background
Constructs a Background node with default parameters. The default values are as follows:- color : black (0,0,0)
image : null
geometry : null
image scale mode : SCALE_NONE
application bounds : null
application bounding leaf : null
Background
- Constructs a Background node with the specified color. This color is used to fill the window prior to drawing any objects in the scene.
Background
- Constructs a Background node with the specified color. This color is used to fill the window prior to drawing any objects in the scene.
Background
- Constructs a Background node with the specified image. If this image is non-null, it is rendered to the window prior to drawing any objects in the scene. If the image is smaller than the window, then that portion of the window not covered by the image is filled with the background color.
- Parameters:
image
- pixel array object used as the background image
Background
- Constructs a Background node with the specified geometry. If non-null, this background geometry is drawn on top of the background color and image using a projection matrix that essentially puts the geometry at infinity. The geometry should be pre-tessellated onto a unit sphere.
- Parameters:
branch
- the root of the background geometry- Throws:
IllegalSharingException
- if the BranchGroup node is a child of any Group node, or is already attached to a Locale, or is already referenced by another Background node.IllegalSceneGraphException
- if specified branch graph contains an illegal node.
Method Detail |
---|
setColor
- Sets the background color to the specified color. This color is used to fill the window prior to drawing any objects in the scene.
- Parameters:
color
- the new background color- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
setColor
- Sets the background color to the specified color. This color is used to fill the window prior to drawing any objects in the scene.
- Parameters:
r
- the red component of the background colorg
- the green component of the background colorb
- the blue component of the background color- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
getColor
- Retrieves the background color.
- Parameters:
color
- the vector that will receive the current background color- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
setImage
- Sets the background image to the specified image. If this image is non-null, it is rendered to the window prior to drawing any objects in the scene. If the image is smaller than the window, then that portion of the window not covered by the image is filled with the background color.
- Parameters:
image
- new pixel array object used as the background image- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
getImage
- Retrieves the background image.
- Returns:
- the current background image
- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
setImageScaleMode
- Sets the image scale mode for this Background node.
- Parameters:
imageScaleMode
- the new image scale mode, one of: SCALE_NONE, SCALE_FIT_MIN, SCALE_FIT_MAX, SCALE_FIT_ALL, SCALE_REPEAT, or SCALE_NONE_CENTER.- Throws:
java.lang.IllegalArgumentException
- ifimageScaleMode
is a value other than SCALE_NONE, SCALE_FIT_MIN, SCALE_FIT_MAX, SCALE_FIT_ALL, SCALE_REPEAT, or SCALE_NONE_CENTER.CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph- Since:
- Java 3D 1.3
getImageScaleMode
- Retrieves the current image scale mode.
- Returns:
- the current image scale mode, one of: SCALE_NONE, SCALE_FIT_MIN, SCALE_FIT_MAX, SCALE_FIT_ALL, SCALE_REPEAT, or SCALE_NONE_CENTER.
- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph- Since:
- Java 3D 1.3
setGeometry
- Sets the background geometry to the specified BranchGroup node. If non-null, this background geometry is drawn on top of the background color and image using a projection matrix that essentially puts the geometry at infinity. The geometry should be pre-tessellated onto a unit sphere.
- Parameters:
branch
- the root of the background geometry- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graphIllegalSharingException
- if the BranchGroup node is a child of any Group node, or is already attached to a Locale, or is already referenced by another Background node.IllegalSceneGraphException
- if specified branch graph contains an illegal node.
getGeometry
- Retrieves the background geometry.
- Returns:
- the BranchGroup node that is the root of the background geometry
- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
setApplicationBounds
- Set the Background's application region to the specified bounds. This is used when the application bounding leaf is set to null.
- Parameters:
region
- the bounds that contains the Background's new application region.- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
getApplicationBounds
- Retrieves the Background node's application bounds.
- Returns:
- this Background's application bounds information
- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
setApplicationBoundingLeaf
- Set the Background's application region to the specified bounding leaf. When set to a value other than null, this overrides the application bounds object.
- Parameters:
region
- the bounding leaf node used to specify the Background node's new application region.- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
getApplicationBoundingLeaf
- Retrieves the Background node's application bounding leaf.
- Returns:
- this Background's application bounding leaf information
- Throws:
CapabilityNotSetException
- if appropriate capability is not set and this object is part of live or compiled scene graph
cloneNode
- Creates a new instance of the node. This routine is called by
cloneTree
to duplicate the current node. - Overrides:
cloneNode
in classNode
- Parameters:
forceDuplicate
- when set totrue
, causes theduplicateOnCloneTree
flag to be ignored. Whenfalse
, the value of each node'sduplicateOnCloneTree
variable determines whether NodeComponent data is duplicated or copied.
Background geometry will not clone in this operation. It is the user's responsibility to callcloneTree
on that branchGroup.- See Also:
Node.cloneTree()
,Node.cloneNode(boolean)
,Node.duplicateNode(javax.media.j3d.Node, boolean)
,NodeComponent.setDuplicateOnCloneTree(boolean)
duplicateNode
Copies all node information fromoriginalNode
Backgrounds 4500x3000
into the current node. This method is called from thecloneNode
method which is, in turn, called by the cloneTree
method. For any
NOTE: Applications should not call this method directly. It should only be called by the cloneNode method.
NodeComponent
objects contained by the object being duplicated, each NodeComponent
object's duplicateOnCloneTree
value is used to determine whether the NodeComponent
should be duplicated in the new node or if just a reference to the current node should be placed in the new node. This flag can be overridden by setting the forceDuplicate
parameter in the cloneTree
method to true
. NOTE: Applications should not call this method directly. It should only be called by the cloneNode method.
- Overrides:
duplicateNode
in classNode
- Parameters:
originalNode
- the original node to duplicate.forceDuplicate
- when set totrue
, causes theduplicateOnCloneTree
flag to be ignored. Whenfalse
, the value of each node'sduplicateOnCloneTree
variable determines whether NodeComponent data is duplicated or copied.- Throws:
java.lang.ClassCastException
- if originalNode is not an instance ofBackground
- See Also:
Node.cloneTree()
,Node.cloneNode(boolean)
,NodeComponent.setDuplicateOnCloneTree(boolean)
updateNodeReferences
Callback used to allow a node to check if any scene graph objects referenced by that node have been duplicated via a call tocloneTree
Backgrounds 50
. This method is called bycloneTree
after all nodes in the sub-graph have been duplicated. The cloned Leaf node's method will be called and the Leaf node can then look up any object references by using the getNewObjectReference
method found in the NodeReferenceTable
object. If a match is found, a reference to the corresponding object in the newly cloned sub-graph is returned. If no corresponding reference is found, either a DanglingReferenceException is thrown or a reference to the original object is returned depending on the value of the Backgrounds 4 0 4
allowDanglingReferences
parameter passed in the cloneTree
call. NOTE: Applications should not call this method directly. It should only be called by the cloneTree method.
- Overrides:
updateNodeReferences
in classSceneGraphObject
- Parameters:
referenceTable
- a NodeReferenceTableObject that contains thegetNewObjectReference
method needed to search for new object instances- See Also:
NodeReferenceTable
,Node.cloneTree()
,DanglingReferenceException
Overview | Package | Class | Tree | Deprecated | Index | Help |
Verified
This tag was signed with a verified signature.GPG key ID: CAA8D9B8E39EC18CLearn about signing commits
Pre-release
- Choose a tag to compare
Verified
This tag was signed with a verified signature.GPG key ID: CAA8D9B8E39EC18CLearn about signing commits
kyleneideck released this Apr 19, 2020
Changes since 0.4.0-SNAPSHOT-bab1ec9 (the last release with a .pkg):
- Fix apps failing to start audio after upgrading Background Music.
- Hopefully fix a segfault caused by BGM_PlayThrough.
- Fix BGMDriver and BGMXPCHelper's version strings for SNAPSHOT builds.
- Add optional debug logging in release builds. Option-click the icon to show it in the menu.
- Fix a bug where BGMDevice would repeat old audio data when audio stopped playing if BGMApp wasn't running. (Thanks to @gchilds.)
background-music-xcarchives-0.4.0-SNAPSHOT-70a64de.zip4.35 MB