RenderAreaSource Class

An ImageSource that displays a user-created Open Inventor scenegraph.

Inheritance Hierarchy

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.WindowsFreezable
        System.Windows.Media.AnimationAnimatable
          System.Windows.MediaImageSource
            System.Windows.InteropD3DImage
              OIV.Inventor.ViewerComponents.Wpf.RenderAreasRenderAreaSource

Namespace: OIV.Inventor.ViewerComponents.Wpf.RenderAreas
Assembly: OIV.Inventor.ViewerComponents.Wpf (in OIV.Inventor.ViewerComponents.Wpf.dll) Version: 2024.1.1.0.Release.cb64a23ffb514e400c7a72e2158dfc53ef4ceb26

Syntax

C++

Copy

public class RenderAreaSource : D3DImage, 
	IDisposable, SiRenderArea, SiRenderAreaInteractive, SiRenderAreaAntialiasing, SiRenderAreaStillSuperSampling

Public Class RenderAreaSource
	Inherits D3DImage
	Implements IDisposable, SiRenderArea, SiRenderAreaInteractive, SiRenderAreaAntialiasing, 
	SiRenderAreaStillSuperSampling

public ref class RenderAreaSource : public D3DImage, 
	IDisposable, SiRenderArea, SiRenderAreaInteractive, SiRenderAreaAntialiasing, SiRenderAreaStillSuperSampling

type RenderAreaSource =  
    class
        inherit D3DImage
        interface IDisposable
        interface SiRenderArea
        interface SiRenderAreaInteractive
        interface SiRenderAreaAntialiasing
        interface SiRenderAreaStillSuperSampling
    end

The RenderAreaSource type exposes the following members.

Constructors

	Name	Description
	RenderAreaSource	Create a new instance of the RenderAreaSource class.

Top

Methods

	Name	Description
	AddDirtyRect	Specifies the area of the back buffer that changed. (Inherited from D3DImage.)
	ApplyAnimationClock(DependencyProperty, AnimationClock)	Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
	ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)	Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
	BeginAnimation(DependencyProperty, AnimationTimeline)	Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
	BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)	Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
	CheckAccess	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
	ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
	ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
	Clone	Creates a modifiable clone of this D3DImage object, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (which may no longer resolve), but not animations or their current values. (Inherited from D3DImage.)
	CloneCurrentValue	Creates a modifiable clone of this D3DImage object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are copied. (Inherited from D3DImage.)
	CoerceValue	Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.)
	Dispose
	Equals	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
	Freeze	Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
	GetAnimationBaseValue	Returns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.)
	GetAntialiasingMode	Gets the antialiasing mode.
	GetAntialiasingQuality	Gets the antialiasing quality value.
	GetAsFrozen	Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
	GetClearColor	Get the RGBA value used when the color buffer is cleared.
	GetClearDepth	Get the depth value used when the depth buffer is cleared.
	GetClearPolicy	Get the color buffer and depth buffer clear policy.
	GetCurrentValueAsFrozen	Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
	GetGLRenderAction	Get the render action used for rendering.
	GetHashCode	Gets a hash code for this DependencyObject. (Inherited from DependencyObject.)
	GetInteractiveMode	Obsolete. Gets the current interactive mode.
	GetLocalValueEnumerator	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
	GetSceneGraph	Get the scene graph displayed.
	GetSceneManager	Get the scene manager.
	GetSize	Get the size to use for rendering.
	GetStillSuperSamplingDelay	Gets delay for supersampling when "still" (not interacting).
	GetStillSuperSamplingQuality	Gets quality for supersampling when "still" (not interacting).
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
	InvalidateProperty	Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
	Lock	Locks the D3DImage and enables operations on the back buffer. (Inherited from D3DImage.)
	ProcessEvent	Propragate a single inventor event to the SoRenderAreaCore owned by the instance.
	ProcessEvents	Propragate a list of inventor events to the SoRenderAreaCore owned by the instance.
	ReadLocalValue	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
	Render	Render the managed scene graph (see setSceneGraph).
	Resize	Resize the image source to the desired size.
	SetAntialiasingMode	Sets the antialiasing mode.
	SetAntialiasingQuality	Sets the antialiasing quality value.
	SetBackBuffer	Assigns a Direct3D surface as the source of the back buffer. (Inherited from D3DImage.)
	SetClearColor	Defines the RGBA value used when the color buffer is cleared.
	SetClearDepth	Defines the depth value used when the depth buffer is cleared.
	SetClearPolicy	Defines the color buffer and depth buffer clear policy.
	SetCurrentValue	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
	SetGLRenderAction	Defines the render action used for rendering.
	SetInteractiveMode	Obsolete. Defines the current interactive mode.
	SetSceneGraph	Set the scenegraph to be displayed.
	SetSize	Defines the size to use for rendering.
	SetStillSuperSamplingDelay	Sets delay for supersampling when "still" (not interacting).
	SetStillSuperSamplingQuality	Sets quality for supersampling when "still" (not interacting).
	SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
	SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
	ToString	Creates a string representation of this object based on the current culture. (Inherited from ImageSource.)
	ToString(IFormatProvider)	Creates a string representation of this object based on the IFormatProvider passed in. If the provider is null, the CurrentCulture is used. (Inherited from ImageSource.)
	TryLock	Attempts to lock the D3DImage and waits for the specified duration. (Inherited from D3DImage.)
	Unlock	Decrements the lock count for the D3DImage. (Inherited from D3DImage.)
	VerifyAccess	Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)

Top

Fields

	Name	Description
	LastRenderStatusProperty	The last render status of the image source.
	PixelHeightProperty	The height (in pixel) of the RenderAreaSource.
	PixelWidthProperty	The width (in pixel) of the RenderAreaSource.

Top

Properties

	Name	Description
	CanFreeze	Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
	DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)
	Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
	HasAnimatedProperties	Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable.)
	Height	Gets the height of the D3DImage. (Inherited from D3DImage.)
	IsFrontBufferAvailable	Gets a value that indicates whether a front buffer exists. (Inherited from D3DImage.)
	IsFrozen	Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
	IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
	LastRenderStatus	Gets the render status of the last render.
	Metadata	Gets the metadata associated with the image source. (Inherited from D3DImage.)
	PixelHeight	Gets or sets the height of the RenderAreaSource, in pixels.
	PixelWidth	Gets or sets the width of the RenderAreaSource, in pixels.
	Width	Gets the width of the D3DImage. (Inherited from D3DImage.)

Top

Events

	Name	Description
	Changed	Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
	IsFrontBufferAvailableChanged	Occurs when the IsFrontBufferAvailable property changes. (Inherited from D3DImage.)
	PostRender	Event raised after the render occurs.
	PreRender	Event raised before the render occurs.
	StartRender	Event raised when a new render starts.

Top

Remarks

Caution
To users of Visual Studio: the Visual Studio designer cannot load components defined in x64 assemblies. Since the assembly containing this type is not targeted AnyCPU, you can only use an assembly which targets x86 to load this component into the designer.

Caution
To users of Visual Studio: in order for the RenderAreaSource component to be correctly loaded into the designer, you must run Visual Studio with the PATH environment variable including the %OIVNETHOME%\assemblies\%OIVARCH% directory (the OIVARCH must be the same as the referenced assemblies) in order for designer process (XDesProc.exe) to find native dependencies of referenced assemblies. The design time working directory differs from the execution time working directory and the designer process ignores the linked resources while copying the referenced assemblies to the new output directory.

Caution

To users of Visual Studio: in order for the RenderAreaSource component to be correctly loaded into the designer, you must run Visual Studio with the PATH environment variable including the %OIVNETHOME%\assemblies\%OIVARCH% directory (the OIVARCH must be the same as the referenced assemblies) in order for designer process (XDesProc.exe) to find native dependencies of referenced assemblies. The design time working directory differs from the execution time working directory and the designer process ignores the linked resources while copying the referenced assemblies to the new output directory.

Reference

OIV.Inventor.ViewerComponents.Wpf.RenderAreas Namespace