com.openinventor.inventor.nodes

Class SoPattern

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.inventor.nodes.SoPattern

All Implemented Interfaces:

SafeDisposable

public class SoPattern
extends SoNode

Node that defines the pattern to use when rendering shapes. This node specifies the current pattern for all subsequent shape nodes in a scene graph.

A pattern is a 32x32 bitmap that is interpreted as a mask of 0s and 1s. Where a 1 appears, the corresponding pixel in the polygon is drawn; where a 0 appears, nothing is drawn. Using patterns is like using screendoor transparency where you specify the pattern of the screen. OpenGL polygon stippling is used to render the pattern.

You can load a pattern file containing one or more patterns using the loadPatterns() method. You can also define and load patterns programmatically using the addPattern() method.

Here is a sample showing the pattern file format.

  "GEOLOGY"
  # The first string is the category name of the first pattern.
  # This is a comment !
  "PATTERN N1"
  # The second string is the name of the pattern.
  # To define the pattern, you must define a 32x32 sequence of
  # '1' and '0'.
  0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
  0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
  0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
  0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 ...
  #============================================
  "PATTERN N2"
  0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
  0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
  0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
  0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 ...

Note:

• A pattern file can contain only one category.
• There is a potential conflict between the use of screendoor transparency and patterned shapes. If the transparency type is screendoor, transparency is ignored for patterned shapes.

Usage Notes

• Patterns can be used for distinguishing, for example, different kinds of rocks in a geologic formation.
• The HardCopy extension (formerly known as PlotMaster) allows you to generate resolution-independent vector hardcopy output. It handles patterns but does not handle textures (they are ignored). If you are planning to use the HardCopy extension, you may want to use patterns rather than textures to distinguish different shapes in your scene graph.

File format/default:

Pattern {

category	""
name	""

}

NOTE: When you write a pattern node out to a file, the file will not contain enough information to fully reconstruct the original scene graph. The pattern node and its current fields are written out (as expected). However, the current fields only specify a category name and a pattern name. They do not specify the actual pattern(s) (like a typical attribute node) or a filename to get the patterns from (like a texture node).

See also:

SoMaterial

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoPattern.FilterTypes Possible value of the filterType used by the method loadPatterns.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFString	category Specifies the name of a group of patterns.
static int	EXCLUSIVE_FILTER Deprecated. Use SoPattern.FilterTypes.EXCLUSIVE_FILTER instead.
static int	INCLUSIVE_FILTER Deprecated. Use SoPattern.FilterTypes.INCLUSIVE_FILTER instead.
SoSFString	name Specifies the name of a pattern within a category.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoPattern() Constructor.

Method Summary

Modifier and Type	Method and Description
static void	addPattern(java.lang.String category, java.lang.String name, byte[] bytes) Adds a new pattern specified as an array of 128 bytes.
static java.lang.String[]	getPatternNames() Gets the list names of all loaded patterns.
static java.lang.String[]	getPatternNames(java.lang.String category) Gets the list names of all loaded patterns in the specified category.
static boolean	loadPatterns(java.lang.String fileName) Calls loadPatterns(fileName, (java.lang.String[])null, SoPattern.FilterTypes.valueOf( SoPattern.FilterTypes.INCLUSIVE_FILTER.getValue() )).
static boolean	loadPatterns(java.lang.String fileName, int numFilters) Calls loadPatterns(fileName, numFilters, (java.lang.String[])null, SoPattern.FilterTypes.valueOf( SoPattern.FilterTypes.INCLUSIVE_FILTER.getValue() )).
static boolean	loadPatterns(java.lang.String fileName, int numFilters, java.lang.String[] filterNames) Calls loadPatterns(fileName, numFilters, filterNames, SoPattern.FilterTypes.valueOf( SoPattern.FilterTypes.INCLUSIVE_FILTER.getValue() )).
static boolean	loadPatterns(java.lang.String fileName, int numFilters, java.lang.String[] filterNames, SoPattern.FilterTypes filterType) Loads a pattern file, with optional filtering of patterns.
static boolean	loadPatterns(java.lang.String fileName, java.lang.String[] filterNames) Calls loadPatterns(fileName, filterNames, SoPattern.FilterTypes.valueOf( SoPattern.FilterTypes.INCLUSIVE_FILTER.getValue() )).
static boolean	loadPatterns(java.lang.String fileName, java.lang.String[] filterNames, SoPattern.FilterTypes filterType) Loads a pattern file, with optional filtering of patterns.

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

INCLUSIVE_FILTER

@Deprecated
public static final int INCLUSIVE_FILTER

Deprecated. Use SoPattern.FilterTypes.INCLUSIVE_FILTER instead.

EXCLUSIVE_FILTER

@Deprecated
public static final int EXCLUSIVE_FILTER

Deprecated. Use SoPattern.FilterTypes.EXCLUSIVE_FILTER instead.

category

public final SoSFString category

Specifies the name of a group of patterns. If the category name is invalid or not found, the default pattern is used.

name

public final SoSFString name

Specifies the name of a pattern within a category. If the pattern name is invalid or not found, the default pattern is used.

Constructor Detail

SoPattern

public SoPattern()

Constructor.

Method Detail

getPatternNames

public static java.lang.String[] getPatternNames()

Gets the list names of all loaded patterns.

getPatternNames

public static java.lang.String[] getPatternNames(java.lang.String category)

Gets the list names of all loaded patterns in the specified category.

loadPatterns

public static boolean loadPatterns(java.lang.String fileName,
                                   int numFilters,
                                   java.lang.String[] filterNames)

Calls loadPatterns(fileName, numFilters, filterNames, SoPattern.FilterTypes.valueOf( SoPattern.FilterTypes.INCLUSIVE_FILTER.getValue() )).

loadPatterns

public static boolean loadPatterns(java.lang.String fileName)

Calls loadPatterns(fileName, (java.lang.String[])null, SoPattern.FilterTypes.valueOf( SoPattern.FilterTypes.INCLUSIVE_FILTER.getValue() )).

loadPatterns

public static boolean loadPatterns(java.lang.String fileName,
                                   java.lang.String[] filterNames)

Calls loadPatterns(fileName, filterNames, SoPattern.FilterTypes.valueOf( SoPattern.FilterTypes.INCLUSIVE_FILTER.getValue() )).

loadPatterns

public static boolean loadPatterns(java.lang.String fileName,
                                   int numFilters)

Calls loadPatterns(fileName, numFilters, (java.lang.String[])null, SoPattern.FilterTypes.valueOf( SoPattern.FilterTypes.INCLUSIVE_FILTER.getValue() )).

addPattern

public static void addPattern(java.lang.String category,
                              java.lang.String name,
                              byte[] bytes)

Adds a new pattern specified as an array of 128 bytes. A category and a name are specified for this pattern. If the category and name are already in the list of patterns, the new pattern will not be added. If either the category or the name is an empty string, no pattern is added.

loadPatterns

public static boolean loadPatterns(java.lang.String fileName,
                                   java.lang.String[] filterNames,
                                   SoPattern.FilterTypes filterType)

Loads a pattern file, with optional filtering of patterns. You can specify the file name with or without a full path. If you specify the file name without the path, the file will be loaded from the directory $OIVHOME/data/patterns. If the file name is not found, a default pattern will be used.

filterNames is an array of pattern names. This will be an array of patterns to include (or exclude) depending on the FilterType. The size of this array is numFilters.

loadPatterns

public static boolean loadPatterns(java.lang.String fileName,
                                   int numFilters,
                                   java.lang.String[] filterNames,
                                   SoPattern.FilterTypes filterType)

Loads a pattern file, with optional filtering of patterns. You can specify the file name with or without a full path. If you specify the file name without the path, the file will be loaded from the directory $OIVHOME/data/patterns. If the file name is not found, a default pattern will be used.

filterNames is an array of pattern names. This will be an array of patterns to include (or exclude) depending on the FilterType. The size of this array is numFilters.