com.openinventor.inventor.caches

Class SoNodeDependencies

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.caches.SoNodeDependencies

All Implemented Interfaces:

SafeDisposable

public class SoNodeDependencies
extends Inventor
implements SafeDisposable

This class is a cache handler that can be used to monitor the modifications made to elements or fields. In order to add new Elements or Fields to be monitored by the cache, use the appropriate addDependency() method.

If one of the added elements or fields has been modified since the last call to updateCache(), the isValid() method will return false, and a subsequent call to updateCache() will make it valid again.

Additionnally, the handled cache can be manually invalidated using the invalidate() method.

Nested Class Summary

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

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoNodeDependencies()

Method Summary

Modifier and Type	Method and Description
void	addDependency(java.lang.Class<? extends Inventor> type, int classStackIndex) Add given element type as a dependency for the cache.
boolean	dispose() Explicitly call this method to force object to dispose its unmanaged resources.
void	invalidate() Manually invalidate the cache.
boolean	isDisposable() Returns a boolean flag which indicates if it is safe to call SafeDisposable.dispose() on the object.
boolean	isValid(SoState state) Returns true if the cache is valid for the given state.
void	updateCache(SoState state) Update cache according to given state.

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

Constructor Detail

SoNodeDependencies

public SoNodeDependencies()

Method Detail

isDisposable

public boolean isDisposable()

Description copied from interface: SafeDisposable

Returns a boolean flag which indicates if it is safe to call SafeDisposable.dispose() on the object.

Specified by:

isDisposable in interface SafeDisposable

Returns:

true if the object can be disposed in a safe manner

dispose

public boolean dispose()

Description copied from class: Inventor

Explicitly call this method to force object to dispose its unmanaged resources. The object may not be reused in the application code after this call.

Specified by:

dispose in interface SafeDisposable

Overrides:

dispose in class Inventor

Returns:

true if this object native resources were successfully disposed; false if it was already disposed or no native resources has been registered for this object.

invalidate

public void invalidate()

Manually invalidate the cache.

addDependency

public void addDependency(java.lang.Class<? extends Inventor> type,
                          int classStackIndex)

Add given element type as a dependency for the cache.

updateCache

public void updateCache(SoState state)

Update cache according to given state. After this call, the cache will be valid.

isValid

public boolean isValid(SoState state)

Returns true if the cache is valid for the given state.