scenic
Class SceneClip

java.lang.Object
  scenic.SceneNode
      scenic.SceneContainer
          scenic.SceneClip

public class SceneClip
extends SceneContainer

This scene node clips its children inside a clip area. The clip area is defined by a scene. The clipping is performed by modulating the child scene with the clip scene. The clip scene is usually a shape, but it can be any scene.

SceneClip can be used to paint a shape with a brush by setting the shape as the clip shape and adding the brush as a child.

Constructor Summary

SceneClip(SceneNode clip)
Construct an SceneClip object with the given clip scene.

Method Summary

SceneNode	getClip() Gets the clip scene.
void	setClip(SceneNode clip) Sets the clip scene.

Methods inherited from class scenic.SceneContainer

add, add, childChanged, clear, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SceneClip

public SceneClip(SceneNode clip)

Construct an SceneClip object with the given clip scene.

Parameters:

clip - the clip scene.

Method Detail

getClip

public SceneNode getClip()

Gets the clip scene.

Returns:

the clip scene.

setClip

public void setClip(SceneNode clip)

Sets the clip scene.

Parameters:

clip - the clip scene.