Home Hierarchy Members Alphabetical Related Pages

ColorInterpolator Class Reference
[Standard Node Types]

#include <colorinterpolator.h>

Inherits Node.

Inheritance diagram for ColorInterpolator:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 ColorInterpolator (const char *name="")
virtual ~ColorInterpolator ()
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.

MFFloat key
MFColor keyValue
Events In
EventIn< SFFloat > set_fraction
EventIn< MFFloat > set_key
EventIn< MFColor > set_keyValue
Events Out
EventOut< SFColor > value_changed
EventOut< MFFloat > key_changed
EventOut< MFColor > keyValue_changed

Detailed Description

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

+ 6.10 ColorInterpolator

This node interpolates among a list of MFColor key values to produce an SFColor (RGB) value_changed event. The number of colours in the keyValue field shall be equal to the number of keyframes in the key field. The keyValue field and value_changed events are defined in RGB colour space. A linear interpolation using the value of set_fraction as input is performed in HSV space (see E.[FOLE] for description of RGB and HSV colour spaces). The results are undefined when interpolating between two consecutive keys with complementary hues.

4.6.8, Interpolator nodes, contains a detailed discussion of interpolators.

--- VRML separator bar ---

Constructor & Destructor Documentation

ColorInterpolator (  const char *  name = ""  ) 
 

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

    		
  







  

    
      

        

          ~ColorInterpolator           
          ( 
                    
           ) 
           [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_fraction
  • 1 : set_key
  • 2 : set_keyValue



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_fraction
  • set_key
  • set_keyValue 




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 : value_changed
  • 1 : key_changed
  • 2 : keyValue_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:
    

  • value_changed
  • key_changed
  • keyValue_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 : key
  • 1 : keyValue 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:
    

  • key
  • keyValue 




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


Implements Node.    

  




Member Data Documentation





  

    
      

        

          MFFloat key          
        

      

    		
  





  

    
       
    
    



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

  







  

    
      

        

          EventOut<MFFloat> key_changed          
        

      

    		
  





  

    
       
    
    



Changed event associated to exposedField key     

  







  

    
      

        

          MFColor keyValue          
        

      

    		
  





  

    
       
    
    



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

  







  

    
      

        

          EventOut<MFColor> keyValue_changed          
        

      

    		
  





  

    
       
    
    



Changed event associated to exposedField keyValue     

  







  

    
      

        

          EventIn<SFFloat> set_fraction          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this event.     

  







  

    
      

        

          EventIn<MFFloat> set_key          
        

      

    		
  





  

    
       
    
    



Set event associated to exposedField key     

  







  

    
      

        

          EventIn<MFColor> set_keyValue          
        

      

    		
  





  

    
       
    
    



Set event associated to exposedField keyValue     

  







  

    
      

        

          EventOut<SFColor> value_changed          
        

      

    		
  





  

    
       
    
    



See Detailed Description for meaning of this event.     

  



  

  

    

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