Home Hierarchy Members Alphabetical Related Pages

GeoElevationGrid Class Reference
[Standard Node Types]

#include <geoelevationgrid.h>

Inherits Node.

Inheritance diagram for GeoElevationGrid:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 GeoElevationGrid (const char *name="")
virtual ~GeoElevationGrid ()
virtual unsigned int nbFields () const
virtual FieldHandle field (const std::string &n)
virtual FieldHandle field (const unsigned int i)
virtual bool isSetToDefaultValue (const unsigned int i) const
virtual unsigned int nbEventsIn () const
virtual EventInHandle eventIn (const std::string &n)
virtual EventInHandle eventIn (const unsigned int i)
virtual unsigned int nbEventsOut () const
virtual EventOutHandle eventOut (const std::string &n)
virtual EventOutHandle eventOut (const unsigned int i)
const char * typeName () const
virtual Node * duplicate () const
virtual Node * duplicate (std::map< const Node *, Node * > &) const

Public Attributes

Exposed Fields
A field that is capable of receiving events via an eventIn to change its value(s), and generating events via an eventOut when its value(s) change.

SFNode color
SFNode normal
SFNode texCoord
Fields
A property or attribute of a node. Each node type has a fixed set of fields. Fields may contain various kinds of data and one or many values. Each field has a default value.

SFBool ccw
SFBool colorPerVertex
SFFloat creaseAngle
SFNode geoOrigin
MFString geoSystem
SFString geoGridOrigin
MFFloat height
SFBool normalPerVertex
SFBool solid
SFInt32 xDimension
SFString xSpacing
SFFloat yScale
SFInt32 zDimension
SFString zSpacing
Events In
EventIn< MFFloat > set_height
EventIn< SFFloat > set_yScale
EventIn< SFNode > set_color
EventIn< SFNode > set_normal
EventIn< SFNode > set_texCoord
Events Out
EventOut< SFNode > color_changed
EventOut< SFNode > normal_changed
EventOut< SFNode > texCoord_changed

Detailed Description

Here is the documentation for this node type, from the ISO standard.

6.24 GeoElevationGrid

The GeoElevationGrid node specifies a uniform grid of elevation values within some spatial reference frame. These are then transparently transformed into a geocentric, curved-earth representation. For example, this would allow a geographer to create a height field where all coordinates are specified in terms of latitude, longitude, and elevation.

The fields color, colorPerVertex, texCoord, normal, and normalPerVertex all have the same meaning as they do for a standard VRML ElevationGrid.

The ccw, solid, and creaseAngle fields are described in 4.6.3, Shapes and geometry.

The geoOrigin field is used to specify a local coordinate frame for extended precision as described in 4.15.5 Dealing with high-precision coordinates.

The geoSystem field is used to define the spatial reference frame and is described in 4.15.3, Encoding a spatial reference frame.

The geoGridOrigin field specifies the geospatial coordinate for the south-west corner (bottom-left) of the dataset. This value should be given in the format described in 4.15.4, Encoding geospatial coordinates.

The height array contains xDimension * zDimension floating point values that represent elevation above the ellipsoid or the geoid, as appropriate. These values are given in row-major order from west to east, south to north. When the geoSystem is GD, xSpacing refers to the number of degrees of longitude between adjacent height values and zSpacing refers to the number of degrees of latitude between vertical height values. When the geoSystem is UTM, xSpacing refers to the number of eastings (metres) between adjacent height values and zSpacing refers to the number of northings (metres) between vertical height values. (Hint: if xDimension = n and the grid spans d units horizontally, the xSpacing value should be set to d / (n-1) ). An eventIn called set_height is provided to allow the height array to be modified dynamically, for example, to support deformations or morphing of terrain surfaces.

The yScale value can be used to produce a vertical exaggeration of the data when it is displayed. By default, this value is 1.0 (no exaggeration). If this value is set to a value greater than 1.0, all heights will appear larger than they actually are. This can be useful for emphasizing elevation change, but the images produced will not represent the true elevation unless yScale is 1.0. An eventIn called set_yScale is provided to allow the vertical exaggeration factor to be altered dynamically.

Constructor & Destructor Documentation

GeoElevationGrid (  const char *  name = ""  ) 
 

Construct a node with all its fields set to default value, which is equivalent to the code below: 

  ccw = true;
  colorPerVertex = true;
  creaseAngle = 0;
  
  geoGridOrigin = string("0 0 0");
  normalPerVertex = true;
  solid = true;
  xDimension = 0;
  xSpacing = string("1.0");
  yScale = 1;
  zDimension = 0;
  zSpacing = string("1.0");

~GeoElevationGrid (   )  [virtual]
 

Virtual destructor, does nothing

Member Function Documentation

wrl::Node * duplicate (  std::map< const Node *, Node * > &   )  const [virtual]
 

Implements Node.

wrl::Node * duplicate (   )  const [virtual]
 

Returns a deep copy of this node, that is a fully independant node with all children (if any) also copied. This is mainly useful for instanciating protos.

Implements Node.

wrl::Node::EventInHandle eventIn (  const unsigned int  n  )  [virtual]
 

Return a handle on the i th event in of the node or a "unknown" typed handle if there is no such node. Here is how i is related to fields:

  • 0 : set_height
  • 1 : set_yScale
  • 2 : set_color
  • 3 : set_normal
  • 4 : set_texCoord

This function is useful, with nbEventsIn() if you want to traverse all events in of a Node.

Implements Node.

wrl::Node::EventInHandle eventIn (  const std::string &  n  )  [virtual]
 

Return a handle on the event in named n of the node or a "unknown" typed handle if there is no such event. Valid names are:

  • set_height
  • set_yScale
  • set_color
  • set_normal
  • set_texCoord

Implements Node.

wrl::Node::EventOutHandle eventOut (  const unsigned int  n  )  [virtual]
 

Return a handle on the i th event out of the node or a "unknown" typed handle if there is no such node. Here is how i is related to fields:

  • 0 : color_changed
  • 1 : normal_changed
  • 2 : texCoord_changed This function is useful, with nbEventsOut() if you want to traverse all events in of a Node.

Implements Node.

wrl::Node::EventOutHandle eventOut (  const std::string &  n  )  [virtual]
 

Return a handle on the event out named n of the node or a "unknown" typed handle if there is no such event. Valid names are:

  • color_changed
  • normal_changed
  • texCoord_changed

Implements Node.

wrl::Node::FieldHandle field (  const unsigned int  n  )  [virtual]
 

Return a handle on the i th field of the node or a "unknown" typed handle if there is no such node. Here is how i is related to fields:

  • 0 : color
  • 1 : normal
  • 2 : texCoord
  • 3 : ccw
  • 4 : colorPerVertex
  • 5 : creaseAngle
  • 6 : geoOrigin
  • 7 : geoSystem
  • 8 : geoGridOrigin
  • 9 : height
  • 10 : normalPerVertex
  • 11 : solid
  • 12 : xDimension
  • 13 : xSpacing
  • 14 : yScale
  • 15 : zDimension
  • 16 : zSpacing This function is useful, with nbFields() if you want to traverse all fields of a Node.

Implements Node.

wrl::Node::FieldHandle field (  const std::string &  n  )  [virtual]
 

Return a handle on the field named n of the node or a "unknown" typed handle if there is no such field. Valid names are:

  • color
  • normal
  • texCoord
  • ccw
  • colorPerVertex
  • creaseAngle
  • geoOrigin
  • geoSystem
  • geoGridOrigin
  • height
  • normalPerVertex
  • solid
  • xDimension
  • xSpacing
  • yScale
  • zDimension
  • zSpacing

Implements Node.

bool isSetToDefaultValue (  const unsigned int  i  )  const [virtual]
 

Implements Node.

unsigned int nbEventsIn (   )  const [inline, virtual]
 

Returns the number of events in for this node type.

Implements Node.

unsigned int nbEventsOut (   )  const [inline, virtual]
 

Returns the number of events out for this node type.

Implements Node.

unsigned int nbFields (   )  const [inline, virtual]
 

Returns the number of fields (exposed or not) for this node type.

Implements Node.

const char * typeName (   )  const [inline, virtual]
 

Returns "GeoElevationGrid". Useful for printing.

Implements Node.

Member Data Documentation

SFBool ccw
 

See Detailed Description for meaning of this field. Default value is set to 

       ccw = true;

SFNode color
 

See Detailed Description for meaning of this field. Default value is set to SFNode default value

EventOut<SFNode> color_changed
 

Changed event associated to exposedField color

SFBool colorPerVertex
 

See Detailed Description for meaning of this field. Default value is set to 

       colorPerVertex = true;

SFFloat creaseAngle
 

See Detailed Description for meaning of this field. Default value is set to 

       creaseAngle = 0;

SFString geoGridOrigin
 

See Detailed Description for meaning of this field. Default value is set to 

       geoGridOrigin = string("0 0 0");

SFNode geoOrigin
 

See Detailed Description for meaning of this field. Default value is set to SFNode default value

MFString geoSystem
 

See Detailed Description for meaning of this field. Default value is set to 

    		
  







  

    
      

        

          MFFloat height          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this field. Default value is set to MFFloat default value     

  







  

    
      

        

          SFNode normal          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this field. Default value is set to SFNode default value     

  







  

    
      

        

          EventOut<SFNode> normal_changed          
        

      

    		
  





  

    
       
    
    



Changed event associated to exposedField normal     

  







  

    
      

        

          SFBool normalPerVertex          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this field. Default value is set to 
       normalPerVertex = true;

    		
  







  

    
      

        

          EventIn<SFNode> set_color          
        

      

    		
  





  

    
       
    
    



Set event associated to exposedField color     

  







  

    
      

        

          EventIn<MFFloat> set_height          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this event.     

  







  

    
      

        

          EventIn<SFNode> set_normal          
        

      

    		
  





  

    
       
    
    



Set event associated to exposedField normal     

  







  

    
      

        

          EventIn<SFNode> set_texCoord          
        

      

    		
  





  

    
       
    
    



Set event associated to exposedField texCoord     

  







  

    
      

        

          EventIn<SFFloat> set_yScale          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this event.     

  







  

    
      

        

          SFBool solid          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this field. Default value is set to 
       solid = true;

    		
  







  

    
      

        

          SFNode texCoord          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this field. Default value is set to SFNode default value     

  







  

    
      

        

          EventOut<SFNode> texCoord_changed          
        

      

    		
  





  

    
       
    
    



Changed event associated to exposedField texCoord     

  







  

    
      

        

          SFInt32 xDimension          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this field. Default value is set to 
       xDimension = 0;

    		
  







  

    
      

        

          SFString xSpacing          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this field. Default value is set to 
       xSpacing = string("1.0");

    		
  







  

    
      

        

          SFFloat yScale          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this field. Default value is set to 
       yScale = 1;

    		
  







  

    
      

        

          SFInt32 zDimension          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this field. Default value is set to 
       zDimension = 0;

    		
  







  

    
      

        

          SFString zSpacing          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this field. Default value is set to 
       zSpacing = string("1.0");

    		
  



  

  

    

      
        
          
            Generated on 24 Feb 2005 with 
            
              doxygen
             version 1.3.9.1.
          
        
      
      
        
          Valid HTML 4.0!
        
        
          Valid CSS!