public class SoRenderAreaCore extends Inventor implements SiRenderAreaAntialiasing, SiRenderAreaTransparency, SiRenderAreaStereo, SiRenderAreaInteractive, SiRenderArea, SiRenderAreaStillSuperSampling, SafeDisposable
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
See also:RenderArea
Inventor.ConstructorCommandSiRenderArea.ClearPolicies, SiRenderArea.RenderEventArg, SiRenderArea.RenderStatusVERBOSE_LEVEL, ZeroHandleABORTED, COLORBUFFER, COLORBUFFER_AND_DEPTHBUFFER, DEPTHBUFFER, INTERACTIVE, NONE, STILL| Constructor and Description |
|---|
SoRenderAreaCore(SoGLContext glContext)
Build a new
SoRenderAreaCore that uses an existing glContext. |
| Modifier and Type | Method and Description |
|---|---|
void |
activateStereo(boolean activate)
Activate (or deactivate) stereo rendering with specified parameters (see setStereoParameters).
|
boolean |
dispose()
Explicitly call this method to force object to dispose its unmanaged
resources.
|
SoSceneManager.AntialiasingModes |
getAntialiasingMode()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. |
float |
getAntialiasingQuality()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. |
SbColorRGBA |
getClearColor()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. |
float |
getClearDepth()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. |
SiRenderArea.ClearPolicies |
getClearPolicy()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. |
SoInteractiveComplexity.InteractiveModes |
getInteractiveMode()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. |
SoNode |
getSceneGraph()
Gets the scene graph which is managed here.
|
SoSceneManager |
getSceneManager() |
SbVec2i32 |
getSize()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. |
SoStereoParameters |
getStereoParameters()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. |
int |
getStillSuperSamplingDelay()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. |
float |
getStillSuperSamplingQuality()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. |
SoGLRenderAction.TransparencyTypes |
getTransparencyType()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. |
boolean |
isDisposable()
Returns a boolean flag which indicates if it is safe to call
SafeDisposable.dispose() on the object. |
boolean |
isStereoActivated()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. |
SbEventHandler<SiRenderArea.RenderEventArg> |
onStartRender()
Returns the event handler that raises when a new render starts.
|
boolean |
processEvent(SoEvent event)
Processes the passed event by applying an
SoHandleEventAction to the scene graph managed here. |
boolean |
processEvents(java.util.Collection<SoEvent> eventList)
Processes the passed event by applying an
SoHandleEventAction to the scene graph managed here. |
SiRenderArea.RenderStatus |
render()
Applies an
SoGLRenderAction to the scene graph managed here. |
void |
setAntialiasingMode(SoSceneManager.AntialiasingModes mode)
Define the antialiasing mode.
|
void |
setAntialiasingQuality(float quality)
Define the antialiasing quality value.
|
void |
setClearColor(SbColorRGBA color)
Defines the RGBA value used when the color buffer is cleared.
|
void |
setClearDepth(float depth)
Defines the depth value used when the depth buffer is cleared.
|
void |
setClearPolicy(SiRenderArea.ClearPolicies policy)
Defines the color buffer and depth buffer clear policy.
|
void |
setInteractiveMode(SoInteractiveComplexity.InteractiveModes mode)
Set the current interactive mode.
|
void |
setSceneGraph(SoNode newScene)
Sets the scene graph which is managed here.
|
void |
setSize(SbVec2i32 size)
Defines the size to use for rendering.
|
void |
setStereoParameters(SoStereoParameters parameters)
Defines the stereo parameters.
|
void |
setStillSuperSamplingDelay(int delay)
Set delay for supersampling when "still" (not interacting).
|
void |
setStillSuperSamplingQuality(float quality)
Set quality for supersampling when "still" (not interacting).
|
void |
setTransparencyType(SoGLRenderAction.TransparencyTypes type)
Sets the algorithm for rendering transparent objects.
|
getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreadspublic SoRenderAreaCore(SoGLContext glContext)
SoRenderAreaCore that uses an existing glContext.
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
public boolean isDisposable()
SafeDisposableSafeDisposable.dispose() on the object.isDisposable in interface SafeDisposabletrue if the object can be disposed in a safe mannerpublic SbEventHandler<SiRenderArea.RenderEventArg> onStartRender()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
onStartRender in interface SiRenderAreapublic boolean dispose()
Inventordispose in interface SafeDisposabledispose in class Inventortrue if this object native resources were successfully
disposed; false if it was already disposed or no
native resources has been registered for this object.public SbVec2i32 getSize()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
getSize in interface SiRenderAreasetSize()public void setStillSuperSamplingDelay(int delay)
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
If greater than 0, images will be supersampled after the specified delay.setStillSuperSamplingDelay in interface SiRenderAreaStillSuperSamplingdelay - The delay is in milliseconds. public void setSize(SbVec2i32 size)
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
Typically this method must be called when the render area has been resized or moved.setSize in interface SiRenderAreapublic void setStillSuperSamplingQuality(float quality)
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
When quality is greater than 0, still images will be automatically supersampled.setStillSuperSamplingQuality in interface SiRenderAreaStillSuperSamplingquality - The quality is a factor in the range [0.0,1.0]. public SoGLRenderAction.TransparencyTypes getTransparencyType()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
getTransparencyType in interface SiRenderAreaTransparencysetTransparencyType()public float getStillSuperSamplingQuality()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
getStillSuperSamplingQuality in interface SiRenderAreaStillSuperSamplingsetStillSuperSamplingQuality()public void setTransparencyType(SoGLRenderAction.TransparencyTypes type)
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
Default is SCREEN_DOOR. SeeSoGLRenderAction for possible transparency types. See also the SoTransparencyType node.
Note: When using transparency types with DELAYED in the name, the depth buffer is not updated (depth buffer writes are disabled) while rendering transparent objects. As a result complex 3D shapes may not be rendered correctly.
setTransparencyType in interface SiRenderAreaTransparencypublic int getStillSuperSamplingDelay()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
getStillSuperSamplingDelay in interface SiRenderAreaStillSuperSamplingsetStillSuperSamplingDelay()public void setSceneGraph(SoNode newScene)
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
This is the Open Inventor scene which will be traversed for rendering and event processing.setSceneGraph in interface SiRenderAreanewScene - : scene graph to be managed.public boolean isStereoActivated()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
isStereoActivated in interface SiRenderAreaStereoactivateStereo()public SoNode getSceneGraph()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
This is the Open Inventor scene which will be traversed for rendering and event processing.getSceneGraph in interface SiRenderAreasetSceneGraph()public SiRenderArea.RenderStatus render()
SoGLRenderAction to the scene graph managed here.
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
See RenderStatus documentation for details on the returned value. The rendering may have been aborted, so check this function result before calling swap buffer for examplerender in interface SiRenderAreapublic boolean processEvents(java.util.Collection<SoEvent> eventList)
SoHandleEventAction to the scene graph managed here.
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
Returns true if at least one event was handled by a node.processEvents in interface SiRenderAreaInteractivepublic boolean processEvent(SoEvent event)
SoHandleEventAction to the scene graph managed here.
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
Returns true if the event was handled by a node.processEvent in interface SiRenderAreaInteractivepublic SoSceneManager getSceneManager()
public void setAntialiasingMode(SoSceneManager.AntialiasingModes mode)
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
setAntialiasingMode in interface SiRenderAreaAntialiasingmode - The antialiasing algorithm. Default is NO_ANTIALIASING which turns off antialiasing.public SiRenderArea.ClearPolicies getClearPolicy()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
getClearPolicy in interface SiRenderAreasetClearPolicy()public void setClearColor(SbColorRGBA color)
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
See also setClearPolicy. Default is transparent black (0,0,0,0).This is equivalent to setBackgroundColor() in the classical view classes.
setClearColor in interface SiRenderAreacolor - RGBA value used to clear the color buffer.public void setClearPolicy(SiRenderArea.ClearPolicies policy)
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
See also setClearColor and setClearDepth. Default is COLORBUFFER_AND_DEPTHBUFFER.
setClearPolicy in interface SiRenderAreapolicy - color buffer and depth buffer clear policy.public void setAntialiasingQuality(float quality)
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
setAntialiasingQuality in interface SiRenderAreaAntialiasingquality - The quality is a factor in the range [0.0,1.0]. public float getAntialiasingQuality()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
getAntialiasingQuality in interface SiRenderAreaAntialiasingsetAntialiasingQuality()public SoSceneManager.AntialiasingModes getAntialiasingMode()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
getAntialiasingMode in interface SiRenderAreaAntialiasingsetAntialiasingMode()public void activateStereo(boolean activate)
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
The stereo mode is determined by which subclass is used to set the parameters. For example, passing anSoRawStereoParameters object activates OpenGL "quad buffered" stereo (if possible on the current graphics board).
SoStereoCamera to be activated. The edited camera is the first stereo camera found in the current scene graph. If no stereo camera is found, a warning is displayed. This method must be called to update the edited camera if the scene graph changed.
activateStereo in interface SiRenderAreaStereopublic float getClearDepth()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
getClearDepth in interface SiRenderAreasetClearDepth()public SoInteractiveComplexity.InteractiveModes getInteractiveMode()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
getInteractiveMode in interface SiRenderAreaInteractivesetInteractiveMode()public void setInteractiveMode(SoInteractiveComplexity.InteractiveModes mode)
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
setInteractiveMode in interface SiRenderAreaInteractivemode - interactive mode. Default is AUTO.public void setStereoParameters(SoStereoParameters parameters)
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
setStereoParameters in interface SiRenderAreaStereoparameters - Provides specific parameters for a stereo mode. Use one of the subclasses of SoStereoParameters.
SoRenderAreaCore makes a copy of the parameter values.
public SbColorRGBA getClearColor()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
getClearColor in interface SiRenderAreasetClearColor()public SoStereoParameters getStereoParameters()
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
getStereoParameters in interface SiRenderAreaStereosetStereoParameters()public void setClearDepth(float depth)
Preview Feature means this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
See also setClearPolicy. Default is 1. Range is 0..1.
setClearDepth in interface SiRenderAreadepth - value used to clear the depth buffer.Generated on July 23, 2025, Copyright © Thermo Fisher Scientific. All rights reserved. http://www.openinventor.com