Cognex.VisionPro3D.Display.Controls

A WPF version of the Cog3DDisplayV2 VisionPro user control

Cog3DDisplayV2

Public interface for the Cog3DDisplayV2 user controls

Save the content of the display into an image file with the current resolution of the display. If the filename attribute is not set, the display will show a Save File Dialog to the user so she can specify the name and location of the file to save the image to.

The name of the file to save the content of the display to.

Save the content of the scene into an image file with the given width and height as the resolution of the resulting image. If the filename attribute is not set, the display will show a Save File Dialog to the user so she can specify the name and location of the file to save the image to.

Throws an ArgumentException if the width is 0 or negative. Throws an ArgumentException if the height is 0 or negative. The width of the resulting image file The height of the resulting image file The name of the file to save the content of the display to.

Reset the camera's location to its default: 0,0,Z, looking at 0,0,0. Zooms to an extent to fit the graphics into the view.

Zooms in and out to fit the content of the world into the view

Change the camera's position and look direction in the 3-D space.

New position of the camera. New target the camera is looking at. New up direction of the camera.

Adds a Cog3DVisionDataGraphicBase item to the display to the given group. Throws an exception if the item is null. Throws an exception if the item has already been added to the display. Throws an exception if the groupName is null or empty string.

Throws an exception if the item is null Throws an exception if the item has already been added to the display. Throws an exception if the groupName is null or empty string. the Cog3DVisionDataGraphicBase item to add to the display The name of the logical group to add the item to. The groupName is case insensitive.

Returns a Cog3DVisionDataGraphicBase item at the given index

the zero based index of the Cog3DVisionDataGraphicBase item to return The Cog3DVisionDataGraphicBase item at the given index

Returns all the Cog3DVisionDataGraphicBase graphic items added to the display

Returns all the Cog3DVisionDataGraphicBase graphic items that has been added to the display but its 3D coordinate space does not hold an entry specified by DisplaySpaceName3D and therefore cannot be rendered

Returns all the Cog3DVisionDataGraphicBase from the given group

The name of the group to return the Cog3DVisionDataGraphicBase from. The groupName is case insensitive. Returns all the Cog3DVisionDataGraphicBase from the given group

Removes the given Cog3DVisionDataGraphicBase from the display with all of its associated geometry graphics.

Throws an exception if the visionDataGraphic is null. Throws an exception if the visionDataGraphic is not on the display.

Removes the given Cog3DVisionDataGraphicBase from the display at the given index. The associated geometry graphics will be removed too.

Throws an exception if the index is outside of the graphic collection's boundaries. The zero based index of the item to remove

Adds the given geometryGraphic to the display. It will be associated with the given VisionDataGraphic and the VisionDataGraphic’s 3D coordinate space tree will be used to resolve the geometry graphic’s SelectedSpaceName3D to the display’s DisplaySpaceName3D. Throws an exception if the geometryGraphic is null. Throws an exception if the geometryGraphic has already been added to the display. Throws an exception if the visionDataGraphic is null. Throws an exception if the visionDataGraphic has NOT yet been added to the display. Throws an exception if the groupName is null or empty string.

Throws an exception if the geometryGraphic is null. Throws an exception if the geometryGraphic has already been added to the display. Throws an exception if the visionDataGraphic is null. Throws an exception if the visionDataGraphic has not yet been added to the display. Throws an exception if the groupName is null or empty string. The geometry graphic to add to the display The vision data graphic to associate the geometry graphic with The name of the logical group to add the geometry graphic to. The groupName is case insensitive.

Returns a Cog3DGeometryGraphicBase item at the given index

the zero based index of the Cog3DGeometryGraphicBase item to return The Cog3DGeometryGraphicBase item at the given index

Returns all the Cog3DGeometryGraphicBase graphic items added to the display

Returns all the Cog3DGeometryGraphicBase graphic items that has been added to the display but its SelectedSpaceName3D could not be resolved because either: - the SelectedSpaceName3D of the geometry graphic can not be found in the associated VisionData's 3D coordinate space tree - or there is something wrong with the associated VisionData's 3D coordinate space tree and therefore it could not be rendered

Returns all the Cog3DGeometryGraphicBase graphic items that has been added to the display but its SelectedSpaceName3D could not be resolved

Returns all the Cog3DGeometryGraphicBase from the given group

The name of the group to return the Cog3DGeometryGraphicBase from. The groupName is case insensitive. Returns all the Cog3DGeometryGraphicBase from the given group

Removes the given Cog3DGeometryGraphicBase from the display

Throws an exception if the geometryGraphic is null. Throws an exception if the geometryGraphic is not on the display. The Cog3DGeometryGraphicBase to remove from the display

Removes the given Cog3DGeometryGraphicBase from the display at the given index

Throws an exception if the index is outside of the graphic collection's boundaries. The zero based index of the item to remove

Removes all the Cog3DVisionDataGraphicBase and Cog3DGeometryGraphicBase graphics from the display from the specified group. NOTE: when it removes a Cog3DVisionDataGraphicBase all of its associated geometry graphics will be removed regardless of which group they are in.

The name of the logical group to add the item to. The groupName is case insensitive.

Cleras the contents of the display

The background color of the display

Gets or sets whether draqing the content of the display is enabled or not. When not enabled, no actual refresh of the display will happen inserting/updating/removing items If adding/updateing/removing multiple items it is advised to disable drawing so no redraw will happen after each individual operation

Gets or sets the name of the coordinate space that needs to be used forrendering RangeImage, PointCloud and any other 3D graphics that is being added to the display NOTE: this is the name of the common shared physical space

Throws an CogSpaceTreeInvalidNameSyntaxException if the DisplaySpaceName3D doesn't have a valid space name syntax.

Gets or sets whether the mouse’s coordinates are tracked in the display. It has to be set to true to figure out the 3D coordinates under the mouse's position. If set to false, mouse coordinates are not tracked and always reported as null.

Returns the 3D coordinates of the mouse pointer. If there is no valid 3D coordinates of the mouse it returns null. The MouseCoordinatesTracked property has to be set to true otherwise mouse coordinates are not tracked at all and will always return null.

Event to signal the change of MouseCoordinates

Returns the camera's position in the world space

Returns the camera's target position (look at) in the world space

Returns the camera's up direction in the world space

Return the number of Cog3DVisionDataGraphicBase items in the display

Return the number of Cog3DGeometryGraphicBase items in the display

Gets or sets the current rendering mode of the display NOTE: Setting the mode to DisplayModes.Vertices may lead to runtime error on Intel HD3000 with the latest Intel grpahics driver (VC5 hardware)

Gets or sets whether the display should automatically figure out the subsampling rate for the Cog3DVisionDataGraphic objects

Gets or sets the subsampling rate in DisplaySpaceName3D units. To make the display use this given value set AutoResolution to false

Default constructor for the WPF 3D display control

Disposes the WPF 3D display control. Needs to be called explicitely when the control needs to be disposed.

Identifies the dependency property.

InitializeComponent

Cog3DDisplayV2StatusBar provides statusbar features and functionalities for ICog3DDisplayV2 display controls.

Cog3DDisplayV2StatusBar

Creates an instance of the 3D display's status bar control

Identifies the dependency property.

Raises the mouse position changed event.

Identifies the dependency property.

Raises the mouse position changed event.

Use this function to explicitly clean up the control. Call this only from the thread the control was created on, if the method is called from any other thread it does nothing. You may call this function multiple times without any ill effects but only the first call - from the appropriate thread - has effect.

Handles the event which occurs when the control hosted in Windows Forms and the application is closing

The sender. The instance containing the event data.

Handles the event which occurs when the control hosted in WPF and the application closing

The sender. The instance containing the event data.

Handles the event which occurs when the control closed, but the application still running

The sender. The instance containing the event data.

Cleans up the control.

Derived classes should override this method to handle the parent closed event.

InitializeComponent

Gets or sets the control for this status bar.

Gets the actual mouse position in the 3-D space.

3D model class. Internal use only.

Gets or sets the rendering resolution. If AutoResolution is false, this value will determine the rendering resolution.

Gets or sets the color of the model.

Wheter true or false, the missing pixels will be rendered

Tells whether the currently displayed model is left-handed or not.

Returns the content of the model

Update (re-render) model

The Windows Forms version of the Cog3DDisplayV2 VisionPro user control

Required designer variable.

Clean up any resources being used.

true if managed resources should be disposed; otherwise, false.

Required method for Designer support - do not modify the contents of this method with the code editor.

Default contsructor for the WinForms version of the 3D display control

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Resets the view to the default initial camera position and view direction. Looking at the scene from the top along the Z axis in a way to fit the whole scene

Renders the content of the display to a PNG with the actual resolution.

The path to the file. If null or emptry string, a SaveFileDialog window will be shown to the user to set the filename.

Renders the contents of the display to a PNG with the given resolution.

The given width. The given height. The path to the file. If null or emptry string, a SaveFileDialog window will be shown to the user to set the filename.

Instantiates the class to be used for the current display based on the impl value

Sets the initial display properties, like background color, etc

Sets the background color of the display under the hood

Called when the DisplaySpaceName3D changed All the existing visiondata needs to be redrawn in the new space

Gets or sets whether updating the screen is enabled or not

This class is a host for the WPF implementation of the

Creates a new Instance of the .

Clean up any resources being used.

true if managed resources should be disposed; otherwise, false.

Gets the underlying WPF control.

A 3D Display Control for rendering 3D Range Images

Cog3DDisplay

Creates an instance of the class

Identifies the dependency property.

The brush changed event.

Raises the brush changed event.

Identifies the dependency property.

The image changed event.

Raises the image changed event.

Identifies the dependency property.

The mouse mode changed event.

Raises the mouse mode changed event.

Raises the moude mode changed event.

Identifies the dependency property.

The mouse position changed event.

Raises the mouse position changed event.

Identifies the dependency property.

The render non visible pixels changed event.

Raises the render non visible pixels changed event.

Identifies the dependency property.

The rotate around mouse down changed event.

Raises the rotate around mouse down changed event.

Identifies the dependency property.

The sampling rate changed event.

Raises the sampling rate changed event.

Identifies the dependency property.

The zoom around mouse down changed event.

Raises the zoom around mouse down changed event.

Zooms to the extents of the sceen.

A value indicating whether to reset the view to the initial state.

Renders the content of the display to a bitmap with the actual resolution.

The rendered content.

Renders the content of the display to a bitmap with the given resolution.

The given width. The given height. The rendered content.

Change the viewport's position and direction in the 3-D space.

New position of the viewport. New looking direction of the viewport. New up direction of the viewport.

InitializeComponent

Gets or sets whether the coordinates of the object under the mouse cursor are visible on the Display

Gets or sets whether the coordinates of the object under the mouse cursor are visible on the Statusbar

Gets or sets the brush to be applied as a material to the 3-D model.

Occurs when the brush changed.

Gets or sets the image currently in the display.

Thrown when the image cannot be rendered.

Occurs when the image changed.

Gets or sets the behavior of the display control in response to mouse input.

Occurs when the mouse mode changed.

Gets the actual mouse position in the 3-D space.

Occurs when the mouse position changed.

Gets or sets a value indicating whether to render not visible pixels.

Occurs when the render non visible pixels property changed.

Gets or sets a value indicating whether to rotate around mouse down point.

Occurs when the rotate around mouse down property changed.

Gets or sets the sampling rate of the model. The higher this value is, the lower the rendering quality will be. For auto-sampling, use 0.

Thrown when the given value is smaller than 0.

Occurs when the sampling rate changed.

Gets or sets a value indicating whether to zoom around mouse down point.

Occurs when the zoom around mouse down property changed.

Returns the current camera position

Returns the camera's look direction

Returns the vector which represents the upward direction for the camera.

Add a graphic item to the display.

The graphic item to add. The Cog3DVisionDataGraphicBase item that holds the 3D coordinate space to resolve the SelectedSpaceName of the item The name of the group the graphic item shall be added to.

updates the geometries that belong to the vision data

Add a graphic item to the display.

The graphic item to add. The name of the group the graphic item shall be added to.