Home Hierarchy Members Alphabetical Related Pages

PointSet Class Reference
[Standard Node Types]

#include <pointset.h>

Inherits Node.

Inheritance diagram for PointSet:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 PointSet (const char *name="")
virtual ~PointSet ()
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 coord
Events In
EventIn< SFNode > set_color
EventIn< SFNode > set_coord
Events Out
EventOut< SFNode > color_changed
EventOut< SFNode > coord_changed

Detailed Description

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

+6.54 PointSet

The PointSet node specifies a set of 3D points, in the local coordinate system, with associated colours at each point. The coord field specifies a Coordinate or GeoCoordinate node (or instance of such a node). The results are undefined if the coord field specifies any other type of node. PointSet uses the coordinates in order. If the coord field is NULL, the point set is considered empty.

PointSet nodes are not lit, not texture-mapped, nor do they participate in collision detection. The size of each point is implementation-dependent.

If the color field is not NULL, it shall specify a Color node that contains at least the number of points contained in the coord node. The results are undefined if the color field specifies any other type of node. Colours shall be applied to each point in order. The results are undefined if the number of values in the Color node is less than the number of values specified in the Coordinate or GeoCoordinate node.

If the color field is NULL and there is a Material node defined for the Appearance node affecting this PointSet node, the emissiveColor of the Material node shall be used to draw the points. More details on lighting equations can be found in 4.14, Lighting model.

Constructor & Destructor Documentation

PointSet (  const char *  name = ""  ) 
 

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

    		
  







  

    
      

        

          ~PointSet           
          ( 
                    
           ) 
           [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. emarks This class has no eventIn. 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_color
  • set_coord 




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 : coord_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
  • coord_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 : coord 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
  • coord 




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 "PointSet". Useful for printing. 


Implements Node.    

  




Member Data Documentation





  

    
      

        

          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     

  







  

    
      

        

          SFNode coord          
        

      

    		
  





  

    
       
    
    



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

  







  

    
      

        

          EventOut<SFNode> coord_changed          
        

      

    		
  





  

    
       
    
    



Changed event associated to exposedField coord     

  







  

    
      

        

          EventIn<SFNode> set_color          
        

      

    		
  





  

    
       
    
    



Set event associated to exposedField color     

  







  

    
      

        

          EventIn<SFNode> set_coord          
        

      

    		
  





  

    
       
    
    



Set event associated to exposedField coord     

  



  

  

    

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