Class vdRayComponent
- Namespace
- vdRay
- Assembly
- vdRay.dll
The main class of the vdRay component that stores all the properties and calls the necessary methods in order to create photorealistic bitmaps.
public sealed class vdRayComponent : UserControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl- Inheritance
-
vdRayComponent
- Implements
- Inherited Members
Constructors
- vdRayComponent()
The consructor of the Class.
Properties
- AntialiasDepth
The depth of the Antialiasing of the object.
- AntialiasThreshold
The Threshold (limit) of the Antialiasing.
- Antialiasing
Whether or not the render will use an Antialiasing algorithm.
- AutoFitBitmap
If true, the component's Width and Height will be used as RenderWidht and RenderHeight.
- AutoRegen
If true, the Regen method is called automatically whenever needed.
- CurrentImage
The Bitmap last rendered with the vdRayComponent.
- Document
The vdDocument that will be rendered to Bitmap.
- FocalLength
The focal length used by the camera in the rendering procedure.
- FreezeEvents
If true, no Event is fired.
- FreezeRefreshEvents
If true, no refresh Event is fired.
- KeepFiles
Whether or not, the temporary files used for the rendering will be deleted.
- LensAngle
The lens' angle used by the camera in the rendering procedure.
- Radiosity
Controls the use of Radiosity. Radiosity is an algorithm that simulates the natural light when illuminating the objects of a scene, creating more realistic images. What Radiosity does is taking into consideration all of the neighbor objects' lighting amount when calculating how bright or dark a specific object will be. Thus said, it's understandable that Radiosity is a quite heavy algorithm that can take many minutes or even hours to render a mid sized bitmap. Radiosity has many properties that affect the quality and time consumption. The benefit of this technique is a big improvement in terms of photorealism, since the output picture can be very realistic. A side benefit is that the ambient light of all the objects of the scene don't have to be set (optional), saving time out of constant testing. By default UseRadiosity property of Radiosity is set to false.
- RenderFlags
The flags defining if Text and Lines will be included in the rendering.
- RenderHeight
Height of Bitmap that will be created.
- RenderWidth
Width of Bitmap that will be created.
- ResourcesDllName
The name of the DLL that contains the edited dialogs of the document.
- SkyFront
SkyFront defines the front center of SkyImage. If, for example you set a bitmap with a red dot at the center of the bitmap, when applied on the sky, this dot will be located at where this vector instructs in WCS coordinations. Keep in mind that this applies only to the SphericalSingle property of SkyImageTypeEnum.
- SkyImage
SkyImage is a bitmap property used as background for your scene, when rendering with vdRay. The bitmap you set, will be applied around the center of your scene, containing every entity in your document. How the image will be set, depends on what you set at the SkyImageTypeEnum property.
- SkyImageType
SkyImageType defines the way the bitmap set as SkyImage will be wrapped.
- SkyTwist
SkyImage will be rotated as many degrees as are set in SkyTwist having as rotation axis the SkyFront Vector property.
Methods
- Dispose(bool)
Clean up any resources being used.
- OnLoad(EventArgs)
Fired every time the component is loaded.
- OnPaint(PaintEventArgs)
Fired every time the component is painted.
- OnResize(EventArgs)
Fired every time the component is resized.
- OpenVideo(Stream)
Opens a VdVideo object.
- OpenVideo(string)
Opens a VdVideo object.
- Pause()
Pauses the rendering procedure.
- Play()
Resumes the rendering procedure if it's paused.
- PlayVideo(VdVideo, int)
Displays the frames of the selected VdVideo object with the set framerate. If framerate is set to -1, default framerate will be used instead. The frames will be displayed in the control.
- Regen()
Clears the primitve collection of the component, forcing it to re-export them. Used whenever there was a change in the document being rendered.
- Render(vdPointView)
Renders the passed vdDocument using the vdRay Engine.
- RenderDocumentModel(object)
Renders the document set in the vdRayComponent using the view properties set by the document (viewAngle, focalLenght etc.).
- RenderOrthographic(vdPointView, double)
Renders the document set in the vdRayComponent in orthrographic mode.
- Stop()
Cancels the rendering procedure.
- createVideo(string, vdPointViews, bool)
Creates a walkthrough vdVideo using the vdRay component.
- getSaveVideoFileDialog(string)
Shows the standard windows SaveDialog.
Events
- OnError
Fired whenever an error occurs during the rendering.
- OnNextFrame
Fired every time a new bitmap is rendered when creating a video.
- OnProgress
Fired whenever progress is made in every of the stages of the rendering.
- OnProgressStart
Fired when the Progress meter is initialized.
- OnProgressStop
Fired when the Progress meter is terminated.
- OnRefresh
Fired every time the bitmap of the rendered image is refreshed.