SoHeightFieldDetail Class

Stores detail information about a picked cell in a heightfield.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.DetailsSoDetail
      OIV.VolumeViz.DetailsSoHeightFieldDetail

Namespace: OIV.VolumeViz.Details
Assembly: OIV.VolumeViz (in OIV.VolumeViz.dll) Version: 2024.1.1.0 (2024.1.1)

Syntax

public class SoHeightFieldDetail : SoDetail

Public Class SoHeightFieldDetail
	Inherits SoDetail

public ref class SoHeightFieldDetail : public SoDetail

type SoHeightFieldDetail =  
    class
        inherit SoDetail
    end

The SoHeightFieldDetail type exposes the following members.

Constructors

	Name	Description
	SoHeightFieldDetail	Constructor.

Methods

	Name	Description
	Clone	(Inherited from SoDetail.)
	Copy	Returns an instance that is a copy of this instance. (Overrides SoDetailCopy.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetColor	Returns the color of the picked cell.
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetHeight	Get the height value of the nearest elevation point.
	GetIjkPos	Returns the position in data space (cell coordinates) of the picked cell.
	GetNumProperties	Returns the number of active properties.
	GetProperty	Returns the specified property and its id.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the value of the picked cell in the specified property (OIV.VolumeViz.Nodes.SoHeightFieldProperty node).
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Remarks

A successful pick operation returns an OIV.Inventor.SoPickedPoint object. If the picked geometry is an OIV.VolumeViz.Nodes.SoHeightFieldRender node, use the getDetail method and cast the result to this class to get extra information about the the pick.

OIV.VolumeViz.Details.SoHeightFieldDetail returns

The i,j,k position of the picked cell (position in data space).
The value of the picked cell retrieved from the current OIV.VolumeViz.Nodes.SoHeightFieldProperty
or the values of the picked cell when multiple OIV.VolumeViz.Nodes.SoHeightFieldProperty nodes are inherited.
The data set of the picked heightfield, i.e., the current OIV.VolumeViz.Nodes.SoHeightFieldProperty node.
or the data sets of the picked heightfield, when multiple OIV.VolumeViz.Nodes.SoHeightFieldProperty nodes are inherited.