SoWpfRenderAreaSource Class

Note: This API is now obsolete.

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.WpfSoWpfRenderAreaSource

Namespace: OIV.Inventor.Wpf
Assembly: OIV.Inventor.Wpf (in OIV.Inventor.Wpf.dll) Version: 9.9.13.0.Release.1490cabe7ee249bd6cc986579d4e6231040bc6f5

Syntax

C++

Copy

[ObsoleteAttribute("This class is obsolete. You may use the RenderAreaSource class provided in %OIVNETHOME%\src\demos\Inventor\Gui\Wpf\WpfViewerComponents folder.")]
public class SoWpfRenderAreaSource : D3DImage, 
	IDisposable

<ObsoleteAttribute("This class is obsolete. You may use the RenderAreaSource class provided in %OIVNETHOME%\src\demos\Inventor\Gui\Wpf\WpfViewerComponents folder.")>
Public Class SoWpfRenderAreaSource
	Inherits D3DImage
	Implements IDisposable

[ObsoleteAttribute(L"This class is obsolete. You may use the RenderAreaSource class provided in %OIVNETHOME%\src\demos\Inventor\Gui\Wpf\WpfViewerComponents folder.")]
public ref class SoWpfRenderAreaSource : public D3DImage, 
	IDisposable

[<ObsoleteAttribute("This class is obsolete. You may use the RenderAreaSource class provided in %OIVNETHOME%\src\demos\Inventor\Gui\Wpf\WpfViewerComponents folder.")>]
type SoWpfRenderAreaSource =  
    class
        inherit D3DImage
        interface IDisposable
    end

The SoWpfRenderAreaSource type exposes the following members.

Constructors

	Name	Description
	SoWpfRenderAreaSource	Create a new instance of the SoWpfRenderAreaSource 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.)
	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.)
	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.)
	GetHashCode	Gets a hash code for this DependencyObject. (Inherited from DependencyObject.)
	GetLocalValueEnumerator	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
	GetSceneManager	Obsolete. Allows to access directly the scene manager associated with the instance.
	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.)
	ReadLocalValue	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
	SetBackBuffer	Assigns a Direct3D surface as the source of the back buffer. (Inherited from D3DImage.)
	SetCurrentValue	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
	SetTransparencyType	Sets the Transparency algorithm used to render transparent part.
	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
	PixelHeightProperty
	PixelWidthProperty

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.)
	IsClearBeforeRender	Gets or sets if the color buffer should be cleared before a render
	IsClearZBufferBeforeRender	Gets or sets if the Z buffer should be cleared before a render
	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.)
	Metadata	Gets the metadata associated with the image source. (Inherited from D3DImage.)
	PixelHeight	Gets or sets the height of the SoWpfRenderAreaSource, in pixels.
	PixelWidth	Gets or sets the width of the SoWpfRenderAreaSource, in pixels.
	SceneManager	Allows to access directly the scene manager associated with the instance.
	TouchManager	Allows to access directly the touch manager associated with the instance.
	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.)

Top

Remarks

In the current version of Open Inventor, we provide only render area functionality for WPF. There is no viewer implementation, which means you need to implement camera manipulation and other features provided by a viewer. Viewer features are scheduled for a future release.

To give a bit of background, the WPF render area was introduced to handle overlap and transparency issues in WPF, but this turned out to have caused lower performance. Also, the WPF render area is a very recent component; we continue to work on it to improve reliability and performance, but in the meantime, as a more a robust solution, we recommend using a WinForm host. (see example "src/Inventor/examples/Features/WPF/WpfHostWinFormHelloCone")

Caution
To users of Visual Studio 2010: 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 2012: we recommend using an updated version of Visual Studio 2012 with at least the update 4 to have correct behavior of designer with our components.

Caution
To users of Visual Studio 2012: in order for the SoWpfRenderAreaSource 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 2012: in order for the SoWpfRenderAreaSource 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.Wpf Namespace