ChangeQueue

ChangeQueue class

Base class for ChangeQueue. Generally used by render plugins to build interactive updating of scenes that are being rendered.

Derived Classes:

Namespace: Rhino.Render.ChangeQueue
ChangeQueue: references

Constructors (3)

ChangeQueue(Guid pluginId, CreatePreviewEventArgs createPreviewEventArgs)

Construct a new ChangeQueue using the given CreatePreviewEventArgs. The preview scene for these args will be used to populate the world.

ChangeQueue(Guid pluginId, uint docRuntimeSerialNumber, ViewInfo viewinfo, bool bRespectDisplayPipelineAttributes)

Construct a new ChangeQueue from the given document

ChangeQueue(Guid pluginId, uint docRuntimeSerialNumber, ViewInfo viewinfo, DisplayPipelineAttributes attributes, bool bRespectDisplayPipelineAttributes, bool bNotifyChanges)

Construct a new ChangeQueue from the given document, using given display pipeline attributes.

Properties (3)

DisplayPipelineAttributes

Get the DisplayPipelineAttributes if available, None otherwise

IsPreview

Return True if this ChangeQueue is created for preview rendering. No view was set for preview rendering.

ViewId

Return view ID for a RhinoDoc based ChangeQueue. Returns Guid.Empty if no view was associated with the changequeue, i.e. preview rendering.

Methods (46)

ApplyClippingPlaneChanges(Guid[] deleted, List<ClippingPlane> addedOrModified)

Override this when you want to handle clippingplane changes

ApplyDisplayPipelineAttributesChanges(DisplayPipelineAttributes displayPipelineAttributes)

Override if you need to react to display attribute changes. This function is needed to be able to react to different sample settings for i.e. capture preview rendering.

ApplyDynamicClippingPlaneChanges(List<ClippingPlane> changed)

Override this when you want to handle dynamicclippingplane changes

ApplyDynamicLightChanges(List<Light> dynamicLightChanges)

Handle dynamic light changes

ApplyDynamicObjectTransforms(List<DynamicObjectTransform> dynamicObjectTransforms)

Handle dynamic object transforms

ApplyEnvironmentChanges(Usage usage)

Override this when you want to handle environment changes

ApplyGroundPlaneChanges(GroundPlane gp)

Override this when you want to handle groundplane changes

ApplyLightChanges(List<Light> lightChanges)

Override this when you want to handle light changes

ApplyLinearWorkflowChanges(LinearWorkflow lw)

Override this when you want to handle linear workflow changes

ApplyMaterialChanges(List<Material> mats)

Override when you want to handle material changes

ApplyMeshChanges(Guid[] deleted, List<Mesh> added)

Override this when you want to handle mesh changes.

ApplyMeshInstanceChanges(List<uint> deleted, List<MeshInstance> addedOrChanged)

Override this when you want to handle mesh instance changes (block instances and first-time added new meshes)

ApplyRenderSettingsChanges(DisplayRenderSettings settings)

Override this when you want to handle render setting changes. These are for the viewport settings.

ApplyRenderSettingsChanges(RenderSettings rs)

Override this when you need to handle background changes (through RenderSettings)

ApplySkylightChanges(Skylight skylight)

Override this when you want to handle skylight changes

ApplySunChanges(Light sun)

Override this when you want to handle sun changes

ApplyViewChange(ViewInfo viewInfo)

Override ApplyViewChange when you want to receive changes to the view/camera

AreViewsEqual(ViewInfo aView, ViewInfo bView)

Compare to ViewInfo instances and decide whether they are equal or not. If you need to change the way the comparison is done you can override this function and implement your custom comparison.

BakeFor()

Override this if you need to control baking behavior for textures. By default bake everything.

BakingSize(RhinoObject ro, RenderMaterial material, TextureType type)

Override this if you need to control the size of the baked bitmaps for textures. By default the value returned is 2048.

ContentRenderHash(RenderContent content, CrcRenderHashFlags flags, string excludeParameterNames, LinearWorkflow lw)

Override this if you need to modify the way render hashes are calcuated in the change queue. This will alter the way materials are grouped.

ConvertCameraBasedLightToWorld(ChangeQueue changequeue, Light light, ViewInfo vp)

Convert given (camera-based) light to a world-based light (in-place)

CrcFromGuid(Guid guid)

Helper function to get a CRC from a Guid.

CreateWorld()

Calls CreateWorld with True passed.

CreateWorld(bool bFlushWhenReady)

Signal the queue to do the initialisation of the queue, seeding it with the content currently available.

Dispose()

Dispose our ChangeQueue

Dispose(bool isDisposing)

Dispose our ChangeQueue. Disposes unmanaged memory.

EnvironmentForid(uint crc)

Get RenderEnvironment for given RenderHash. Can return null.

EnvironmentFromOriginalInstanceId(Guid id)

Get the RenderEnvironment from the ChangeQueue content cache from the original instance id

EnvironmentIdForUsage(Usage usage)

Get RenderEnvironment RenderHash for given usage.

Flush()

Tell the ChangeQueue to flush all collected events. This can trigger a host of Apply* calls. The following is the order in which those calls get made if there are changes for that specific data type: ApplyViewChange ApplyLinearWorkflowChanges ApplyDynamicObjectTransforms ApplyDynamicLightChanges ApplyRenderSettingsChanges ApplyEnvironmentChanges (background) ApplyEnvironmentChanges (refl) ApplyEnvironmentChanges (sky) ApplySkylightChanges ApplySunChanges ApplyLightChanges ApplyMaterialChanges ApplyMeshChanges ApplyMeshInstanceChanges ApplyGroundPlaneChanges ApplyClippingPlaneChanges

GetQueueGroundPlane()

Get groundplane known to the queue at the time of the Flush

GetQueueRenderSettings()

Get render settings known to the queue at the time of the Flush

GetQueueSceneBoundingBox()

Get the scene bounding box

GetQueueSkylight()

Get skylight known to the queue at the time of the Flush

GetQueueSun()

Get sun known to the queue at the time of the Flush

GetQueueView()

Get view known to the queue at the time of the Flush

MaterialFromId(uint crc)

Get the RenderMaterial from the ChangeQueue material cache based on RenderHash

MaterialFromOriginalInstanceId(Guid id)

Get the RenderMaterial from the ChangeQueue material cache from the original instance id

NotifyBeginUpdates()

Override this when you want to be notified of begin of changes

NotifyDynamicUpdatesAreAvailable()

Override this when you want to be notified dynamic updates are available

NotifyEndUpdates()

Override this when you want to be notified when change notifications have ended.

OneShot()

Call Flush() once, after that automatically dispose the queue.

ProvideOriginalObject()

Override ProvideOriginalObject and return True if you want original objects supplied with ChangeQueue.Mesh. This will then also allow access to the Attributes.UserData of the original object from which the Mesh was generated.

TextureForId(uint crc)

Get RenderTexture for given RenderHash. Can return null.

TextureFromOriginalInstanceId(Guid id)

Get the RenderTexture from the ChangeQueue content cache from the original instance id

Nothing found