The IHeightField graph node interface. More...

#include "murl_graph_i_height_field.h"

Inherited by Murl::Graph::TerrainGeometry.

Public Member Functions

virtual INodeGetNodeInterface ()=0
 Get the mutable Graph::INode interface. More...
 
virtual const INodeGetNodeInterface () const =0
 Get the constant Graph::INode interface. More...
 
virtual Real GetFieldSizeX () const =0
 Get the height field's extent along the X axis. More...
 
virtual Real GetFieldSizeZ () const =0
 Get the height field's extent along the Z axis. More...
 
virtual Real GetFieldElevation (Real posX, Real posZ) const =0
 Get the height field's elevation (Y coordinate) for a given XZ coordinate. More...
 

Detailed Description

The IHeightField graph node interface.

This interface represents a generic height field, which consists of a rectangular data set representing discrete points in the XZ plane with exactly one elevation value at a given XZ coordinate.

Member Function Documentation

◆ GetNodeInterface() [1/2]

virtual INode* Murl::Graph::IHeightField::GetNodeInterface ( )
pure virtual

Get the mutable Graph::INode interface.

This method returns a mutable pointer to the node's Graph::INode interface, to be able to query or modify common node properties such as active state, visibility or ID.

Returns
The mutable Graph::INode interface, or null if not available

◆ GetNodeInterface() [2/2]

virtual const INode* Murl::Graph::IHeightField::GetNodeInterface ( ) const
pure virtual

Get the constant Graph::INode interface.

This method returns a constant pointer to the node's Graph::INode interface, to be able to query common node properties such as active state, visibility or ID.

Returns
The constant Graph::INode interface, or null if not available

◆ GetFieldSizeX()

virtual Real Murl::Graph::IHeightField::GetFieldSizeX ( ) const
pure virtual

Get the height field's extent along the X axis.

Returns
The X dimension of the height field.

◆ GetFieldSizeZ()

virtual Real Murl::Graph::IHeightField::GetFieldSizeZ ( ) const
pure virtual

Get the height field's extent along the Z axis.

Returns
The Z dimension of the height field.

◆ GetFieldElevation()

virtual Real Murl::Graph::IHeightField::GetFieldElevation ( Real  posX,
Real  posZ 
) const
pure virtual

Get the height field's elevation (Y coordinate) for a given XZ coordinate.

Parameters
posXThe X coordinate to query.
posZThe Z coordinate to query.
Returns
The (interpolated) Y elevation at the given XZ coordinate.

The documentation for this interface was generated from the following file:
  • murl_graph_i_height_field.h


Copyright © 2011-2018 Spraylight GmbH.