Public interface for the Cog3DDisplayV2 user controls
Namespace: Cognex.VisionPro3DAssembly: Cognex.VisionPro3D.Display.Controls (in Cognex.VisionPro3D.Display.Controls.dll) Version: 65.1.0.0 (65.1.0.0)
Syntax
The ICog3DDisplayV2 type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | Add(Cog3DVisionDataGraphicBase, String) |
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.
|
| Add(Cog3DGeometryGraphicBase, Cog3DVisionDataGraphicBase, String) |
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.
|
| Clear |
Cleras the contents of the display
|
| FitView |
Zooms in and out to fit the content of the world into the view
|
| GetGeometryGraphic |
Returns a Cog3DGeometryGraphicBase item at the given index
|
| GetGeometryGraphics |
Returns all the Cog3DGeometryGraphicBase graphic items added to the display
|
| GetGeometryGraphics(String) |
Returns all the Cog3DGeometryGraphicBase from the given group
|
| GetLostAndFoundGeometryGraphics |
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
|
| GetLostAndFoundVisionDataGraphics |
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
|
| GetVisionDataGraphic |
Returns a Cog3DVisionDataGraphicBase item at the given index
|
| GetVisionDataGraphics |
Returns all the Cog3DVisionDataGraphicBase graphic items added to the display
|
| GetVisionDataGraphics(String) |
Returns all the Cog3DVisionDataGraphicBase from the given group
|
| Remove(String) |
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.
|
| Remove(Cog3DGeometryGraphicBase) |
Removes the given Cog3DGeometryGraphicBase from the display
|
| Remove(Cog3DVisionDataGraphicBase) |
Removes the given Cog3DVisionDataGraphicBase from the display with all of its associated geometry graphics.
|
| RemoveGeometryGraphicByIndex |
Removes the given Cog3DGeometryGraphicBase from the display at the given index
|
| RemoveVisionDataGraphicByIndex |
Removes the given Cog3DVisionDataGraphicBase from the display at the given index.
The associated geometry graphics will be removed too.
|
| ResetView |
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.
|
| SaveAsImage(String) |
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.
|
| SaveAsImage(Int32, Int32, String) |
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.
|
| SetView |
Change the camera's position and look direction in the 3-D space.
|
Properties
| Name | Description | |
|---|---|---|
 | AutoResolution |
Gets or sets whether the display should automatically figure out the
subsampling rate for the Cog3DVisionDataGraphic objects
|
| BackColor |
The background color of the display
|
| CameraPosition |
Returns the camera's position in the world space
|
| CameraTarget |
Returns the camera's target position (look at) in the world space
|
| CameraUpDirection |
Returns the camera's up direction in the world space
|
| DisplayMode |
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)
|
| DisplaySpaceName3D |
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
|
| EnableDrawing |
Gets or sets whether dragging 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/updating/removing multiple items it is advised to
disable drawing so no redraw will happen after each individual
operation.
|
| GeometryGraphicsCount |
Return the number of Cog3DGeometryGraphicBase items in the display
|
| MouseCoordinates |
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.
|
| MouseCoordinatesTracked |
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.
|
| Resolution |
Gets or sets the subsampling rate in DisplaySpaceName3D units. To make the display use this given value set AutoResolution to false
|
| VisionDataGraphicsCount |
Return the number of Cog3DVisionDataGraphicBase items in the display
|
Events
| Name | Description | |
|---|---|---|
 | MouseCoordinatesChanged |
Event to signal the change of MouseCoordinates
|
See Also