java.lang.Object
- com.aspose.threed.Renderer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public abstract class Renderer
extends java.lang.Object
implements java.io.Closeable
```
The context about renderer.

Field Summary

Fields
Modifier and Type Field Description

protected java.util.HashMap<java.lang.String,EntityRenderer> entityRenderersByKey
Registered entity renderers

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`beginTarget(IRenderTarget target)`	Begin render on specified render target
`void`	`clearCache()`	Manually clear the cache.
`void`	`close()`	Dispose the `Renderer` and all related resources
`static Renderer`	`createRenderer()`	Creates a new `Renderer` with default profile.
`protected void`	`dispose(boolean disposing)`	Dispose the `Renderer` and all related resources
`protected void`	`endTarget()`	End rendering on specified render target.
`protected void`	`endViewport()`	Finished rendering on specified viewport
`abstract void`	`execute(PostProcessing postProcessing, IRenderTarget result)`	Execute an post processing on specified render target
`java.util.ArrayList<java.lang.String>`	`getAssetDirectories()`	Directories that stored external assets
`boolean`	`getEnableShadows()`	Gets whether to enable shadows.
`protected EntityRenderer`	`getEntityRenderer(Entity entity)`	Get the entity renderer that used to render the specified entity, or return fallback renderer if no entity renderer was registered.
`EntityRenderer`	`getFallbackEntityRenderer()`	Gets the fallback entity renderer when the entity has no special renderer defined.
`Frustum`	`getFrustum()`	Gets the frustum that used to provide view matrix.
`Material`	`getMaterial()`	Gets the material that used to provide material information used by shaders.
`Node`	`getNode()`	Gets the `getNode()` instance used to provide world transform matrix.
`PostProcessing`	`getPostProcessing(java.lang.String name)`	Gets a built-in post-processor that supported by the renderer.
`java.util.List<PostProcessing>`	`getPostProcessings()`	Active post-processing chain
`PresetShaders`	`getPresetShaders()`	Gets the preset shader set
`abstract RenderFactory`	`getRenderFactory()`	Gets the factory to build render-related objects.
`RenderStage`	`getRenderStage()`	Gets the current render stage.
`IRenderTarget`	`getRenderTarget()`	Specify the render target that the following render operations will be performed on.
`ShaderProgram`	`getShader()`	Gets the shader instance used for rendering the geometry.
`ShaderSet`	`getShaderSet()`	Gets the shader set that used to render the scene
`RendererVariableManager`	`getVariables()`	Access to the internal variables used for rendering
`protected void`	`initViewport(Viewport viewport, RelativeRectangle relArea, Frustum frustum)`	Begin rendering on specified viewport
`void`	`registerEntityRenderer(EntityRenderer renderer)`	Register the entity renderer for specified entity
`void`	`render(IRenderTarget renderTarget)`	Render the specified target
`void`	`setEnableShadows(boolean value)`	Sets whether to enable shadows.
`void`	`setFallbackEntityRenderer(EntityRenderer value)`	Sets the fallback entity renderer when the entity has no special renderer defined.
`void`	`setFrustum(Frustum value)`	Sets the frustum that used to provide view matrix.
`void`	`setMaterial(Material value)`	Sets the material that used to provide material information used by shaders.
`void`	`setNode(Node value)`	Sets the `getNode()` instance used to provide world transform matrix.
`void`	`setPresetShaders(PresetShaders value)`	Sets the preset shader set
`void`	`setShader(ShaderProgram value)`	Sets the shader instance used for rendering the geometry.
`void`	`setShaderSet(ShaderSet value)`	Sets the shader set that used to render the scene

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - entityRenderersByKey
```
protected java.util.HashMap<java.lang.String,EntityRenderer> entityRenderersByKey
```
    Registered entity renderers
- Method Detail
  - clearCache
```
public void clearCache()
                throws java.io.IOException
```
    Manually clear the cache. Aspose.3D will cache some objects like materials/geometries into internal types that compatible with the render pipeline. This should be manually called when scene has major changes.
    
    Throws:
    
    java.io.IOException
  - getShaderSet
```
public ShaderSet getShaderSet()
```
    Gets the shader set that used to render the scene
  - setShaderSet
```
public void setShaderSet(ShaderSet value)
                  throws java.io.IOException
```
    Sets the shader set that used to render the scene
    
    Parameters:
    
    value - New value
    
    Throws:
    
    java.io.IOException
  - getVariables
```
public RendererVariableManager getVariables()
```
    Access to the internal variables used for rendering
  - getPresetShaders
```
public PresetShaders getPresetShaders()
```
    Gets the preset shader set
  - setPresetShaders
```
public void setPresetShaders(PresetShaders value)
                      throws java.io.IOException
```
    Sets the preset shader set
    
    Parameters:
    
    value - New value
    
    Throws:
    
    java.io.IOException
  - getRenderFactory
```
public abstract RenderFactory getRenderFactory()
```
    Gets the factory to build render-related objects.
  - getAssetDirectories
```
public java.util.ArrayList<java.lang.String> getAssetDirectories()
```
    Directories that stored external assets
  - getPostProcessings
```
public java.util.List<PostProcessing> getPostProcessings()
```
    Active post-processing chain
  - getPostProcessing
```
public PostProcessing getPostProcessing(java.lang.String name)
```
    Gets a built-in post-processor that supported by the renderer.
    
    Parameters:
    
    name -
  - execute
```
public abstract void execute(PostProcessing postProcessing,
                             IRenderTarget result)
```
    Execute an post processing on specified render target
  - getEnableShadows
```
public boolean getEnableShadows()
```
    Gets whether to enable shadows.
  - setEnableShadows
```
public void setEnableShadows(boolean value)
```
    Sets whether to enable shadows.
    
    Parameters:
    
    value - New value
  - getRenderTarget
```
public IRenderTarget getRenderTarget()
```
    Specify the render target that the following render operations will be performed on.
  - getNode
```
public Node getNode()
```
    Gets the getNode() instance used to provide world transform matrix.
  - setNode
```
public void setNode(Node value)
```
    Sets the getNode() instance used to provide world transform matrix.
    
    Parameters:
    
    value - New value
  - getFrustum
```
public Frustum getFrustum()
```
    Gets the frustum that used to provide view matrix.
  - setFrustum
```
public void setFrustum(Frustum value)
```
    Sets the frustum that used to provide view matrix.
    
    Parameters:
    
    value - New value
  - getRenderStage
```
public RenderStage getRenderStage()
```
    Gets the current render stage.
  - getMaterial
```
public Material getMaterial()
```
    Gets the material that used to provide material information used by shaders.
  - setMaterial
```
public void setMaterial(Material value)
```
    Sets the material that used to provide material information used by shaders.
    
    Parameters:
    
    value - New value
  - getShader
```
public ShaderProgram getShader()
```
    Gets the shader instance used for rendering the geometry.
  - setShader
```
public void setShader(ShaderProgram value)
```
    Sets the shader instance used for rendering the geometry.
    
    Parameters:
    
    value - New value
  - initViewport
```
protected void initViewport(Viewport viewport,
                            RelativeRectangle relArea,
                            Frustum frustum)
```
    Begin rendering on specified viewport
  - endViewport
```
protected void endViewport()
```
    Finished rendering on specified viewport
  - beginTarget
```
protected void beginTarget(IRenderTarget target)
```
    Begin render on specified render target
    
    Parameters:
    
    target -
  - endTarget
```
protected void endTarget()
```
    End rendering on specified render target.
  - createRenderer
```
public static Renderer createRenderer()
```
    Creates a new Renderer with default profile.
    
    Throws:
    
    RendererException
  - dispose
```
protected void dispose(boolean disposing)
                throws java.io.IOException
```
    Dispose the Renderer and all related resources
    
    Parameters:
    
    disposing -
    
    Throws:
    
    java.io.IOException
  - getFallbackEntityRenderer
```
public EntityRenderer getFallbackEntityRenderer()
```
    Gets the fallback entity renderer when the entity has no special renderer defined.
  - setFallbackEntityRenderer
```
public void setFallbackEntityRenderer(EntityRenderer value)
```
    Sets the fallback entity renderer when the entity has no special renderer defined.
    
    Parameters:
    
    value - New value
  - registerEntityRenderer
```
public void registerEntityRenderer(EntityRenderer renderer)
```
    Register the entity renderer for specified entity
    
    Parameters:
    
    renderer -
  - getEntityRenderer
```
protected EntityRenderer getEntityRenderer(Entity entity)
```
    Get the entity renderer that used to render the specified entity, or return fallback renderer if no entity renderer was registered.
    
    Parameters:
    
    entity -
  - render
```
public void render(IRenderTarget renderTarget)
```
    Render the specified target
    
    Parameters:
    
    renderTarget -
  - close
```
public void close()
           throws java.io.IOException
```
    Dispose the Renderer and all related resources
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Throws:
    
    java.io.IOException

Class Renderer

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

entityRenderersByKey

Method Detail

clearCache

getShaderSet

setShaderSet

getVariables

getPresetShaders

setPresetShaders

getRenderFactory

getAssetDirectories

getPostProcessings

getPostProcessing

execute

getEnableShadows

setEnableShadows

getRenderTarget

getNode

setNode

getFrustum

setFrustum

getRenderStage

getMaterial

setMaterial

getShader

setShader

initViewport

endViewport

beginTarget

endTarget

createRenderer

dispose

getFallbackEntityRenderer

setFallbackEntityRenderer

registerEntityRenderer

getEntityRenderer

render

close