"Cognex.VisionPro3D.Graphic"
Gets or sets the rendering mode for the display
Gets the camera's current up direction in the 3D scene's world space name
Gets the camera's current target position in the 3D scene's world space name
Gets the camera's current position in the 3D scene's world space name
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.
Event is fired when has changed
Gets the current mouse coordinates in the 3D scene's world space name
NOTE: if has to be set to true to get the current mouse coordinates, otherwise the value is invalid and null.
Gets or sets whether the coordinates of the mouse cursor are tracked or not
Renders the contents of the display to a PNG with the given resolution.
The given width.
The given height.
The path of the PNG file
Removes the Cog3DGraphicBase object from the display
If the graphic is a then all of the dependent will be removed too.
the key of the graphic to be removed
Updates the Cog3DGeometryGraphicBase object on the display
the key of the graphic on the display
the Cog3DGeometryGraphicBase to update
the transofrm to be used on the shape (map the vertices from the selected space name 3d of the shape to the displays displaySpaceName3D)
the transofrm to be used on the geometry graphics to map the vertices from the SelectedSpaceName3D of the graphic to the display's displaySpaceName3D
Adds a Cog3DGeometryGraphicBase to the display
the key of the group to add the Cog3DGeometryGraphicBase to
the ICog3DShapeGraphic to add
the transofrm to be used on the geometry graphics to map the vertices from the SelectedSpaceName3D of the graphic to the display's displaySpaceName3D
the unique identifier of the graphic in the display
Creates a group for ICog3DShapeGraphic with the given name
the name of the group
the unique identifier of the group in the display
Saves the content of the screen to the disk for debug purposes
i.e. HOOPS will create HMF files from the model and the view objects that could be examined in HOOPS 3D Viewer
file name postfix to use
Updates the Cog3DVisionDataGraphicBase object on the display
the key of the graphic on the display
the Cog3DVisionDataGraphicBase to update
the name of the sapce to be used for rendering
the resolution in displaySpaceName3D units to be used for rendering
If true, the geometry of the VisionData will be re-rendered
Adds a Cog3DVisionDataGraphicBase to the display
the key of the group to add the Cog3DVisionDataGraphicBase to
the Cog3DVisionDataGraphicBase to add
the name of the sapce to be used for rendering
the resolution in displaySpaceName3D units to be used for rendering
return the unique identifier of the item on the display
Creates a group for ICog3DVisionDataGraphic with the given name
the name of the group
the unique identifier of the group in the display
Returns whether the screen refresh is enabled or not
Enables refreshing the screen
Disables refreshing the screen
Clears the content of the screen
Zooms in/out to fit all the drawn objects into the view
Does not change the camera's orientation.
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
Updates the screen. Forces redraw.
Sets the background color of the display
The color to be set
This is the interface for the 3D display implementation class. The Cog3DDisplayV2 user control holds
a ICog3DDisplayImpl member that represents the actual 3D engine implementation behind the scenes...
This enum defines the available display modes for rendering 3D content
The display will render the vertices of the 3D objects
The display will render the surfaces of the 3D objects
This class is a helper class to initialize the low level 3D graphic buffer
Creates a list of Cog3DVisionDataGraphicBase graphic wrappers from the CogVisionDataContainer input if it is supported.
In case the input type is not supported, it return null or throws a NotSupportedException
based on the value of the throwIfNotSupported argument.
The following CogVisionDataContainers are supported:
-
If it is a flat CogVisionDataContainer and all of its entries are .
-
If its entries are CogVisionDataContainer themselves and each of those elements contains in turn
exactly one and one .
Creates a Cog3DVisionDataGraphicBase graphic wrapper from the ICogVisionData input if it is supported.
In case the input type is not supported, it returns null or throws a NotSupportedException
based on the value of the throwIfNotSupported argument.
The following types are supported:
- if the followings are true:
-
It has one or many entries.
In this case the first one will be used to create a from it.
-
It has exactly one and one .
In this case the both of them will be used to create a that has grey overlay set.
-
The collection contains at least one element that is itself a CogVisionDataContainer, and that element
contains in turn exactly one CogImage16Range and one CogImage16Grey.
In this case the first RangeImage and its grey pair will be used to create a that has grey overlay set.
This class is a 3D graphic factory class that can
create the graphic wrapper for ICogVisionData, Shapes, etc.
Compares two Cog3DSphereGraphic for equality.
First instance of a Cog3DSphereGraphic to compare to the other.
Second instance of a Cog3DSphereGraphic to compare to the other.
Tolerance when comparing number values for equality.
Gets the underlying Cog3DSphere object of this graphic.
Serialization constructor for Cog3DSphereGraphic object.
The standard SerializationInfo argument.
The standard StreamingContext argument.
Finalize this Cog3DSphereGraphic.
Destruct this Cog3DSphereGraphic.
Copy constructor.
The Cog3DSphereGraphic to copy.
Constructor that takes shape.
The shape to be used in the 3D graphic.
This class defines a 3D Sphere graphic.
It inherites from the base class
Compares two Cog3DCircleGraphic for equality.
First instance of a Cog3DCircleGraphic to compare to the other.
Second instance of a Cog3DCircleGraphic to compare to the other.
Tolerance when comparing number values for equality.
Gets/sets the DisplayState for this Cog3DCircleGraphic
The default value is Cog3DDisplayStateConstants::WireFrame.
Available values are Surface, SurfaceWithWireFrame and WireFrame
The DisplayState of this graphic object.
If trying to set to anything other than Surface, SurfaceWithWireFrame or WireFreame
Fires when this property changes.
The following state flags may be affected:
- SfDisplayState
Gets the underlying Cog3DCircle object of this graphic.
Serialization constructor for Cog3DCircleGraphic object.
The standard SerializationInfo argument.
The standard StreamingContext argument.
Finalize this Cog3DCircleGraphic.
Destruct this Cog3DCircleGraphic.
Copy constructor.
The Cog3DCircleGraphic to copy.
Constructor that takes shape.
The shape to be used in the 3D graphic.
This class defines a 3D Circle graphic.
It inherites from the base class
Compares two Cog3DPointGraphic for equality.
First instance of a Cog3DPointGraphic to compare to the other.
Second instance of a Cog3DPointGraphic to compare to the other.
Tolerance when comparing number values for equality.
Gets/sets the DisplayState for the Pointment
The default value is Cog3DDisplayStateConstants::WireFrame and it cannot be changed for this Cog3DPointmentGraphic.
The DisplayState of this graphic object.
If trying to set to anything other than WireFrame
Fires when this property changes.
The following state flags may be affected:
- SfDisplayState
Gets the underlying Cog3DPoint object of this graphic.
Serialization constructor for Cog3DPointGraphic object.
The standard SerializationInfo argument.
The standard StreamingContext argument.
Finalize this Cog3DPointGraphic.
Destruct this Cog3DPointGraphic.
Copy constructor.
The Cog3DPointGraphic to copy.
Constructor that takes shape.
The shape to be used in the 3D graphic.
This class defines a 3D Point graphic.
It inherites from the base class
Compares two Cog3DRectangleGraphic for equality.
First instance of a Cog3DRectangleGraphic to compare to the other.
Second instance of a Cog3DRectangleGraphic to compare to the other.
Tolerance when comparing number values for equality.
Gets/sets the DisplayState for the Circle
The default value is Cog3DDisplayStateConstants::WireFrame.
Available values are Surface, SurfaceWithWireFrame and WireFrame
The DisplayState of this graphic object.
If trying to set to anything other than WireFreame, SurfaceWithWireFrame or Surface
Fires when this property changes.
The following state flags may be affected:
- SfDisplayState
Gets the underlying Cog3DRectangle object of this graphic.
Serialization constructor for Cog3DRectangleGraphic object.
The standard SerializationInfo argument.
The standard StreamingContext argument.
Finalize this Cog3DRectangleGraphic.
Destruct this Cog3DRectangleGraphic.
Copy constructor.
The Cog3DRectangleGraphic to copy.
Constructor that takes shape.
The shape to be used in the 3D graphic.
This class defines a 3D Rectangle graphic.
It inherites from the base class
Compares two Cog3DLineSegGraphic for equality.
First instance of a Cog3DLineSegGraphic to compare to the other.
Second instance of a Cog3DLineSegGraphic to compare to the other.
Tolerance when comparing number values for equality.
Gets/sets the DisplayState for the LineSegment
The default value is Cog3DDisplayStateConstants::WireFrame and it cannot be changed for this Cog3DLineSegmentGraphic.
The DisplayState of this graphic object.
If trying to set to anything other than WireFrame
Fires when this property changes.
The following state flags may be affected:
- SfDisplayState
Gets the underlying Cog3DLineSeg object of this graphic.
Serialization constructor for Cog3DLineSegGraphic object.
The standard SerializationInfo argument.
The standard StreamingContext argument.
Finalize this Cog3DLineSegGraphic.
Destruct this Cog3DLineSegGraphic.
Copy constructor.
The Cog3DLineSegGraphic to copy.
Constructor that takes shape.
The shape to be used in the 3D graphic.
This class defines a 3D LineSeg graphic.
It inherites from the base class
Compares two Cog3DBoxGraphic for equality.
First instance of a Cog3DBoxGraphic to compare to the other.
Second instance of a Cog3DBoxGraphic to compare to the other.
Tolerance when comparing number values for equality.
Gets the underlying Cog3DBox object of this graphic.
Serialization constructor for Cog3DBoxGraphic object.
The standard SerializationInfo argument.
The standard StreamingContext argument.
Finalize this Cog3DBoxGraphic.
Destruct this Cog3DBoxGraphic.
Copy constructor.
The Cog3DBoxGraphic to copy.
Constructor that takes shape.
The shape to be used in the 3D graphic.
This class defines a 3D box graphic.
It inherites from the base class
Gets or sets the name of the three dimensional
coordinate space of the underlying shape of this graphic.
Fires when this property changes.
Gets the underlying Cog3DShapeBase object of this graphic.
Gets/sets the DisplayState for this graphic object.
The default value is Cog3DDisplayStateConstants::DisplayDefault.
It can be used to force an object to be always rendered as WireFrame or Vertices regardless of what the display settings are for rendering.
The DisplayState of this graphic object.
If setting the DisplayState to anything other than Surface, SurfaceWithWireFrame, WireFreame
DisplayState of a Cog3DShapeGeometryGraphic cannot be set to DisplayDefault or Vertices.
The individual derived classes may override this restriction.
Fires when this property changes.
The following state flags may be affected:
- SfDisplayState
Compares two Cog3DShapeGraphicBase for equality.
First instance of a Cog3DShapeGraphicBase to compare to the other.
Second instance of a Cog3DShapeGraphicBase to compare to the other.
Tolerance when comparing number values for equality.
Serialization constructor for Cog3DGraphicBase object.
The standard SerializationInfo argument.
The standard StreamingContext argument.
Finalize this Cog3DShapeGraphicBase.
Destruct this Cog3DShapeGraphicBase.
Copy constructor.
The Cog3DShapeGraphicBase to copy.
Constructor
This file defines the base class 3D ShapeGraphic Base objects
It inherits from class
Gets or sets the name of the three dimensional
coordinate space to be used by tools which process this geometry graphic.
Fires when this property changes.
Gets/sets the DisplayState for this geometry graphic object.
The DisplayState of this geometry graphic object.
If a DisplayState is set to anything other than Surface, SurfaceWithWireFrame, WireFrame or Vertices
DisplayState of a Cog3DGeometryGraphic by default cannot be set to DisplayDefault
The individual derived classes may override this restriction
Fires when this property changes.
The following state flags may be affected:
- SfDisplayState
Compares two Cog3DGeometryGraphicBase for equality.
First instance of a Cog3DGeometryGraphicBase to compare to the other.
Second instance of a Cog3DGeometryGraphicBase to compare to the other.
Tolerance when comparing number values for equality.
fire the GeometryChanged event with the approproate stateflag coming from the real geometry object
Serialization constructor for Cog3DGeometryGraphicBase object.
The standard SerializationInfo argument.
The standard StreamingContext argument.
Finalize this Cog3DGeometryGraphicBase.
Destruct this Cog3DGeometryGraphicBase.
Copy constructor.
The Cog3DGeometryGraphicBase instance to copy.
If is diposed.
Default constructor.
The default color of the graphic object.
The default display state of the graphic object.
This abstarct base class is used to specify common properties of 3D geometry related graphic objects.
Gets/sets whether the grey data should be shown during rendering for coloring the object
The default value is true. NOTE: only has an effect when the GreyImage is available
Fires when this property changes.
The following state flags may be affected:
- SfShowGreyImage
Returns whether the grey data is available with the RangeImage constructor.
Gets the grey-scale pair of the range image (if available)
Gets the RangeImage object of the Cog3DGraphicImage16Range object
Serialization constructor for Cog3DGraphicImage16Range object.
The standard SerializationInfo argument.
The standard StreamingContext argument.
Finalize this Cog3DRangeImageGraphic.
Destruct this Cog3DGraphicImage16Range.
Copy constructor.
The Cog3DRangeImageGraphic to copy.
Constructor that takes a CogImage16Range and a CogImage16Grey pair
The CogImage16Range to be used as 3D Graphic. It cannot be null.
The CogImage16Grey pair of the RangeImage. It cannot be null and
has to have the same dimensions (width, height) as the RangeImage
Constructor that takes a CogImage16Range. This RangeImage will be handled as one that does not have grey data in it.
The Cog3DRangeImageGraphic to be used as 3D Graphic.
This class defines a RangeImage 3D graphic.
It inherits from class
Common flags corresponding with properties of a 3D graphic changed
Serialization constructor for Cog3DGraphicBase object.
The standard SerializationInfo argument.
The standard StreamingContext argument.
Gets the underlying ICogVisionData of the VisionDataGraphic object
Gets the 3D Coordinate Space Tree of the VisionDataGraphic object
Finalize this Cog3DVisionDataGraphicBase.
Destruct this Cog3DVisionDataGraphicBase.
Copy constructor.
The Cog3DVisionDataGraphicBase to copy.
Constructor
Event if fired when the 3D coordinate space tree of the VisionData has changed,
or a change happened within the tree itself
This file defines the base class 3D VisionDataGraphic objects
It inherits from class
Gets/sets the DisplayState for this graphic object.
It can be used to force an object to be always rendered as WireFrame or Vertices regardless of what the display settings are for rendering.
The DisplayState of this graphic object.
If a DisplayState other than DisplayDefault, Surface, SurfaceWithWireFrame, WireFreame or Vertices
Fires when this property changes.
The following state flags may be affected:
- SfDisplayState
Gets/sets the MarkerSize for this graphic object in screen units.
Applies only if rendered as vertices
The default value is 1.0.
The MarkerSize of this graphic object in screen units.
The MarkerSize for graphic objects must be greaer than 0.
Fires when this property changes.
The following state flags may be affected:
- SfMarkerSize
Gets/sets the LineWidth for this graphic object in screen units.
Applies only if rendered as WireFrame or SurfaceWithWireFrame.
The default value is 1.
The LineWidth of this graphic object in screen units.
The LineWidth for graphic objects must be greater or equal 1.
Fires when this property changes.
The following state flags may be affected:
- SfLineWidth
Gets/sets the Visibility for this graphic object.
The default value is true.
The Visibility of this graphic object.
Fires when this property changes.
The following state flags may be affected:
- SfVisible
Gets/sets the Opacity for this graphic object.
The value range is 0.0 - 1.0, where 0.0 means full transparent
and value 1.0 means full opaque.
The default value is 1.0.
The Opacity of this graphic object. Must be between 0 and 1.
The Opacity for graphic objects must be between 0 and 1.
Fires when this property changes.
The following state flags may be affected:
- SfOpacity
Gets/sets the Color for this graphic object.
The Color of this craphic object.
Color cannot be set to CogColorConstants::None
Fires when this property changes.
The following state flags may be affected:
- SfColor
Compares two Cog3DGraphicBase for equality.
First instance of a Cog3DGraphicBase to compare to the other.
Second instance of a Cog3DGraphicBase to compare to the other.
Tolerance when comparing number values for equality.
Serialization constructor for Cog3DGraphicBase object.
The standard SerializationInfo argument.
The standard StreamingContext argument.
Finalize this Cog3DGraphicBase.
Destruct this Cog3DGraphicBase.
Copy constructor.
The Cog3DGraphicBase instance to copy.
If is null.
If is diposed.
Default constructor.
The default color of the graphic object.
The default display state of the graphic object.
This bit will be set in the EventArgs of a Changed event every time
the value returned by DisplayState may have changed.
This bit will be set in the EventArgs of a Changed event every time
the value returned by MarkerSize may have changed.
This bit will be set in the EventArgs of a Changed event every time
the value returned by LineWidth may have changed.
This bit will be set in the EventArgs of a Changed event every time
the value returned by Visible may have changed.
This bit will be set in the EventArgs of a Changed event every time
the value returned by Opacity may have changed.
This bit will be set in the EventArgs of a Changed event every time
the value returned by Color may have changed.
This file defines the base class for 3D graphics objects
This enum defines the available display states for 3D graphics.
The graphic's display state defines the way of rendering of a 3D graphics.
The graphic's vertices will always be rendered
The graphic's wireframe will always be rendered
The graphic's surface and wireframe will always be rendered
The graphic's surface will always be rendered
The graphic will follow the rendering mode of the display. Available for ICogVisionDataGraphic only