C# Класс RhinoCyclesCore.RenderEngine

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
DisplayLock object
RenderedSamples int
Session Session
TimeString string

Защищенные свойства (Protected)

Свойство Тип Описание
PluginId Guid
PreviewEventArgs CreatePreviewEventArgs
m_display_update_callback CSycles.DisplayUpdateCallback
m_doc_serialnumber uint
m_flush bool
m_test_cancel_callback CSycles.TestCancelCallback
m_update_callback CSycles.UpdateCallback
m_update_render_tile_callback CSycles.RenderTileCallback
m_view ViewInfo
m_write_render_tile_callback CSycles.RenderTileCallback

Открытые методы

Метод Описание
CheckFlushQueue ( ) : void

Check if we should change render engine status. If the changequeue has notified us of any changes Flush will be true. If we're rendering then move to State.Halted and cancel our current render progress.

ColorClamp ( int ch ) : int

Clamp color so we get valid values for system bitmap

Continue ( ) : void
CreateFloat4 ( Color color ) : float4
CreateFloat4 ( byte x, byte y, byte z, byte w ) : float4
CreateFloat4 ( double x, double y, double z ) : float4
CreateWorld ( ) : void

Tell our changequeue instance to initialise world.

DegToRad ( float ang ) : float
DisplayBuffer ( uint sessionId, uint tx, uint ty, uint tw, uint th ) : void

Update the RenderWindow or RenderBitmap with the updated tile from Cycles render progress.

FlushIt ( ) : void

Flush

IsPreview ( ) : bool

True if rendering for preview

LoggerCallback ( string msg ) : void

Callback for debug logging facility. Will be called only for Debug builds of ccycles.dll

Pause ( ) : void
RenderEngine ( Guid pluginId, CreatePreviewEventArgs previewEventArgs, bool interactive ) : System
RenderEngine ( Guid pluginId, uint docRuntimeSerialnumber, ViewInfo view, ViewportInfo vp, bool interactive ) : System
RenderEngine ( Guid pluginId, uint docRuntimeSerialNumber, bool interactive ) : System
SaveRenderedBuffer ( int sample ) : void
SetFloatTextureAsByteTexture ( bool floatAsByte ) : void

OpenCL doesn't properly support HDRi textures in the environment, so read them as byte textures instead.

SetProgress ( RenderWindow rw, string msg, float progress ) : void

Set progress to RenderWindow, if it is not null.

SetProjectionMode ( Shader shader, CyclesTextureImage texture, ImageTextureNode image_node, TextureCoordinateNode texture_coordinates ) : void

Set image texture node and link up with correct TextureCoordinateNode output based on texture ProjectionMode. This may add new nodes to the shader!

StopRendering ( ) : void

Called when user presses the stop render button.

TestCancel ( uint sid ) : void
TriggerChangesReady ( ) : void
TriggerSamplesChanged ( int samples ) : void
TriggerStatusTextUpdated ( StatusTextEventArgs e ) : void

Tell engine to fire StatusTextEvent with given arguments

UpdateCallback ( uint sid ) : void

Handle status updates

UpdateRenderTileCallback ( uint sessionId, uint x, uint y, uint w, uint h, uint depth, int startSample, int numSamples, int sample, int resolution ) : void

Handle update render tile callback

WriteRenderTileCallback ( uint sessionId, uint x, uint y, uint w, uint h, uint depth, int startSample, int numSamples, int sample, int resolution ) : void

Handle write render tile callback

Защищенные методы

Метод Описание
CreateScene ( Client client, Device render_device, RenderEngine cycles_engine ) : Scene

create a ccl.Scene

Database_FilmUpdateTagged ( object sender, EventArgs e ) : void
Database_LightShaderChanged ( object sender, LightShaderUpdatedEventArgs e ) : void
Database_LinearWorkflowChanged ( object sender, LinearWorkflowChangedEventArgs e ) : void
Database_MaterialShaderChanged ( object sender, MaterialShaderUpdatedEventArgs e ) : void
SetCallbacks ( ) : void

Register the callbacks to the render engine session

UploadData ( ) : bool

Main entry point for uploading data to Cycles.

Приватные методы

Метод Описание
CreateCyclesShaderFromRhinoV6BasicMat ( CyclesShader shader ) : ccl.Shader
CreateCyclesShaderFromXml ( CyclesShader shader ) : ccl.Shader
CreateMaterialShader ( CyclesShader shader ) : ccl.Shader
CreateSimpleEmissionShader ( CyclesLight light ) : ccl.Shader
HasSceneChanges ( ) : bool

Return true if any change has been received through the changequeue

ReCreateSimpleEmissionShader ( CyclesLight light, ccl.Shader emission_shader ) : ccl.Shader
RecreateBackgroundShader ( CyclesBackground background, RhinoShader &currentShader ) : void
RecreateCyclesShaderFromRhinoV6BasicMat ( CyclesShader shader, ccl.Shader existing ) : ccl.Shader
RecreateCyclesShaderFromXml ( CyclesShader shader, ccl.Shader existing ) : ccl.Shader
RecreateMaterialShader ( CyclesShader shader, ccl.Shader existing ) : ccl.Shader
RegisterEventHandler ( ) : void
SetTextureImage ( EnvironmentTextureNode envnode, CyclesTextureImage texture ) : void
SetTextureImage ( ImageTextureNode imnode, CyclesTextureImage texture ) : void
StopTheRenderer ( ) : void

Описание методов

CheckFlushQueue() публичный Метод

Check if we should change render engine status. If the changequeue has notified us of any changes Flush will be true. If we're rendering then move to State.Halted and cancel our current render progress.
public CheckFlushQueue ( ) : void
Результат void

ColorClamp() публичный статический Метод

Clamp color so we get valid values for system bitmap
public static ColorClamp ( int ch ) : int
ch int
Результат int

Continue() публичный Метод

public Continue ( ) : void
Результат void

CreateFloat4() публичный статический Метод

public static CreateFloat4 ( Color color ) : float4
color System.Drawing.Color
Результат float4

CreateFloat4() публичный статический Метод

public static CreateFloat4 ( byte x, byte y, byte z, byte w ) : float4
x byte
y byte
z byte
w byte
Результат float4

CreateFloat4() публичный статический Метод

public static CreateFloat4 ( double x, double y, double z ) : float4
x double
y double
z double
Результат float4

CreateScene() защищенный статический Метод

create a ccl.Scene
protected static CreateScene ( Client client, Device render_device, RenderEngine cycles_engine ) : Scene
client Client Client to create scene for
render_device Device Render device to use
cycles_engine RenderEngine Engine instance to create for
Результат Scene

CreateWorld() публичный Метод

Tell our changequeue instance to initialise world.
public CreateWorld ( ) : void
Результат void

Database_FilmUpdateTagged() защищенный Метод

protected Database_FilmUpdateTagged ( object sender, EventArgs e ) : void
sender object
e EventArgs
Результат void

Database_LightShaderChanged() защищенный Метод

protected Database_LightShaderChanged ( object sender, LightShaderUpdatedEventArgs e ) : void
sender object
e LightShaderUpdatedEventArgs
Результат void

Database_LinearWorkflowChanged() защищенный Метод

protected Database_LinearWorkflowChanged ( object sender, LinearWorkflowChangedEventArgs e ) : void
sender object
e LinearWorkflowChangedEventArgs
Результат void

Database_MaterialShaderChanged() защищенный Метод

protected Database_MaterialShaderChanged ( object sender, MaterialShaderUpdatedEventArgs e ) : void
sender object
e MaterialShaderUpdatedEventArgs
Результат void

DegToRad() публичный статический Метод

public static DegToRad ( float ang ) : float
ang float
Результат float

DisplayBuffer() публичный Метод

Update the RenderWindow or RenderBitmap with the updated tile from Cycles render progress.
public DisplayBuffer ( uint sessionId, uint tx, uint ty, uint tw, uint th ) : void
sessionId uint
tx uint
ty uint
tw uint
th uint
Результат void

FlushIt() публичный Метод

Flush
public FlushIt ( ) : void
Результат void

IsPreview() публичный Метод

True if rendering for preview
public IsPreview ( ) : bool
Результат bool

LoggerCallback() публичный статический Метод

Callback for debug logging facility. Will be called only for Debug builds of ccycles.dll
public static LoggerCallback ( string msg ) : void
msg string
Результат void

Pause() публичный Метод

public Pause ( ) : void
Результат void

RenderEngine() публичный Метод

public RenderEngine ( Guid pluginId, CreatePreviewEventArgs previewEventArgs, bool interactive ) : System
pluginId Guid
previewEventArgs CreatePreviewEventArgs
interactive bool
Результат System

RenderEngine() публичный Метод

public RenderEngine ( Guid pluginId, uint docRuntimeSerialnumber, ViewInfo view, ViewportInfo vp, bool interactive ) : System
pluginId Guid
docRuntimeSerialnumber uint
view ViewInfo
vp ViewportInfo
interactive bool
Результат System

RenderEngine() публичный Метод

public RenderEngine ( Guid pluginId, uint docRuntimeSerialNumber, bool interactive ) : System
pluginId Guid
docRuntimeSerialNumber uint
interactive bool
Результат System

SaveRenderedBuffer() публичный Метод

public SaveRenderedBuffer ( int sample ) : void
sample int
Результат void

SetCallbacks() защищенный Метод

Register the callbacks to the render engine session
protected SetCallbacks ( ) : void
Результат void

SetFloatTextureAsByteTexture() публичный Метод

OpenCL doesn't properly support HDRi textures in the environment, so read them as byte textures instead.
public SetFloatTextureAsByteTexture ( bool floatAsByte ) : void
floatAsByte bool
Результат void

SetProgress() публичный Метод

Set progress to RenderWindow, if it is not null.
public SetProgress ( RenderWindow rw, string msg, float progress ) : void
rw RenderWindow
msg string
progress float
Результат void

SetProjectionMode() публичный статический Метод

Set image texture node and link up with correct TextureCoordinateNode output based on texture ProjectionMode. This may add new nodes to the shader!
public static SetProjectionMode ( Shader shader, CyclesTextureImage texture, ImageTextureNode image_node, TextureCoordinateNode texture_coordinates ) : void
shader Shader
texture CyclesTextureImage
image_node ImageTextureNode
texture_coordinates TextureCoordinateNode
Результат void

StopRendering() публичный Метод

Called when user presses the stop render button.
public StopRendering ( ) : void
Результат void

TestCancel() публичный Метод

public TestCancel ( uint sid ) : void
sid uint
Результат void

TriggerChangesReady() публичный Метод

public TriggerChangesReady ( ) : void
Результат void

TriggerSamplesChanged() публичный Метод

public TriggerSamplesChanged ( int samples ) : void
samples int
Результат void

TriggerStatusTextUpdated() публичный Метод

Tell engine to fire StatusTextEvent with given arguments
public TriggerStatusTextUpdated ( StatusTextEventArgs e ) : void
e StatusTextEventArgs
Результат void

UpdateCallback() публичный Метод

Handle status updates
public UpdateCallback ( uint sid ) : void
sid uint
Результат void

UpdateRenderTileCallback() публичный Метод

Handle update render tile callback
public UpdateRenderTileCallback ( uint sessionId, uint x, uint y, uint w, uint h, uint depth, int startSample, int numSamples, int sample, int resolution ) : void
sessionId uint
x uint
y uint
w uint
h uint
depth uint
startSample int
numSamples int
sample int
resolution int
Результат void

UploadData() защищенный Метод

Main entry point for uploading data to Cycles.
protected UploadData ( ) : bool
Результат bool

WriteRenderTileCallback() публичный Метод

Handle write render tile callback
public WriteRenderTileCallback ( uint sessionId, uint x, uint y, uint w, uint h, uint depth, int startSample, int numSamples, int sample, int resolution ) : void
sessionId uint
x uint
y uint
w uint
h uint
depth uint
startSample int
numSamples int
sample int
resolution int
Результат void

Описание свойств

DisplayLock публичное свойство

Lock object to protect buffer access.
public object DisplayLock
Результат object

PluginId защищенное свойство

protected Guid PluginId
Результат Guid

PreviewEventArgs защищенное свойство

protected CreatePreviewEventArgs PreviewEventArgs
Результат CreatePreviewEventArgs

RenderedSamples публичное свойство

public int RenderedSamples
Результат int

Session публичное свойство

Reference to the session of this render engine instance.
public Session Session
Результат Session

TimeString публичное свойство

public string TimeString
Результат string

m_display_update_callback защищенное свойство

protected CSycles.DisplayUpdateCallback m_display_update_callback
Результат CSycles.DisplayUpdateCallback

m_doc_serialnumber защищенное свойство

protected uint m_doc_serialnumber
Результат uint

m_flush защищенное свойство

protected bool m_flush
Результат bool

m_test_cancel_callback защищенное свойство

protected CSycles.TestCancelCallback m_test_cancel_callback
Результат CSycles.TestCancelCallback

m_update_callback защищенное свойство

protected CSycles.UpdateCallback m_update_callback
Результат CSycles.UpdateCallback

m_update_render_tile_callback защищенное свойство

protected CSycles.RenderTileCallback m_update_render_tile_callback
Результат CSycles.RenderTileCallback

m_view защищенное свойство

protected ViewInfo m_view
Результат ViewInfo

m_write_render_tile_callback защищенное свойство

protected CSycles.RenderTileCallback m_write_render_tile_callback
Результат CSycles.RenderTileCallback