SIMAnimationStandardItf Interface CATIAnimationValue

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIAnimationValue

Role: Interface dedicated for the accessing an animation object.

This interface provides authoring capability for animation object. The end-user must make sure the proper setup (licensing) is available for data creation. 




 
Method Index
 



 
 o 
    GetInterpolationMode(CATUnicodeString&)

 
Role: Retrieves the interpolation mode used.
 
 o 
    GetInterpretType(CATUnicodeString&)

 
Role: Retrieves the Interpret Type used.
 
 o 
    GetValueBoolean(CATBoolean&)

 
Role: Retrieves the boolean value.
 
 o 
    GetValuesDouble(CATRawColldouble**)

 
Role: Retrieves all the double values.
 
 o 
    GetValuesInteger(CATRawCollint**)

 
Role: Retrieves all the integer values.
 
 o 
    GetValuesString(CATListValCATUnicodeString&)

 
Role: Retrieves all the string values.
 
 o 
    GetVariantLineValue(double&)

 
Role: Retrieves the variant value.
 
 o 
    SetInterpolationMode(CATUnicodeString&)

 
Role: Sets the interpolation mode to use.
 
 o 
    SetInterpretType(CATUnicodeString&)

 
Role: Sets the Interpret Type to use.
 
 o 
    SetValueBoolean(CATBoolean&)

 
Role: Set a boolean value.
 
 o 
    SetValuesDouble(CATRawColldouble&)

 
Role: Set all the double values.
 
 o 
    SetValuesInteger(CATRawCollint&)

 
Role: Set all the integer values.
 
 o 
    SetValuesString(CATListValCATUnicodeString&)

 
Role: Set all the string values.
 
 o 
    SetVariantLineValue(double)

 
Role: Sets the variant value.










 
Methods
 

 
 o GetInterpolationMode


  
  public virtual   GetInterpolationMode( oInterpolation)  



  


Role: Retrieves the interpolation mode used.



  
 Parameters:
  

    

    
 oInterpolation
   
 [out] The interpolation identifier used for this animation value.
 







 
 o GetInterpretType


  
  public virtual   GetInterpretType( oInterpretType)  



  


Role: Retrieves the Interpret Type used.



  
 Parameters:
  

    

    
 oInterpolation
   
 [out] The Interpret Type identifier used for this animation value.
 







 
 o GetValueBoolean


  
  public virtual   GetValueBoolean( oValue)  



  


Role: Retrieves the boolean value. Retrieves the boolean
 value associated with this animation value object.



  
 Parameters:
  

    

    
 oValues
   
 [out] The list of values.




  
 Returns: 
  
     An HRESULT value.
   
Legal values:
   

     
S_OK
The values are successfully retrieved.

     
E_NOTIMPL
The method is not supported for this animation
 value.

   

 




 
 o GetValuesDouble


  
  public virtual   GetValuesDouble( oValues)  



  


Role: Retrieves all the double values. Retrieves the list of
 double values associated with this animation value object.



  
 Parameters:
  

    

    
 oValues
   
 [out] The list of values.




  
 Returns: 
  
     An HRESULT value.
   
Legal values:
   

     
S_OK
The values are successfully retrieved.

     
E_NOTIMPL
The method is not supported for this animation
 value.

   

 




 
 o GetValuesInteger


  
  public virtual   GetValuesInteger( oValues)  



  


Role: Retrieves all the integer values. Retrieves the list of
 integer values associated with this animation value object.



  
 Parameters:
  

    

    
 oValues
   
 [out] The list of values.




  
 Returns: 
  
     An HRESULT value.
   
Legal values:
   

     
S_OK
The values are successfully retrieved.

     
E_NOTIMPL
The method is not supported for this animation
 value.

   

 




 
 o GetValuesString


  
  public virtual   GetValuesString( oValue)  



  


Role: Retrieves all the string values. Retrieves the list of
 string values associated with this animation value object.



  
 Parameters:
  

    

    
 oValues
   
 [out] The list of values.




  
 Returns: 
  
     An HRESULT value.
   
Legal values:
   

     
S_OK
The values are successfully retrieved.

     
E_NOTIMPL
The method is not supported for this animation
 value.

   

 




 
 o GetVariantLineValue


  
  public virtual   GetVariantLineValue( oVariantValue)  



  


Role: Retrieves the variant value. The variant value is the
 index used for animation. It is paired with the actual animation values.



  
 Parameters:
  

    

    
 oVariantLine
   
 [out] The variant value is expressed in MKS unit.
 







 
 o SetInterpolationMode


  
  public virtual   SetInterpolationMode( const  iInterpolation)  



  


Role: Sets the interpolation mode to use.



  
 Parameters:
  

    

    
 oInterpolation
   
 [out] The interpolation identifier to use for this animation value.
 







 
 o SetInterpretType


  
  public virtual   SetInterpretType( const  iInterpretType)  



  


Role: Sets the Interpret Type to use.



  
 Parameters:
  

    

    
 oInterpolation
   
 [out] The Interpret Type identifier to use for this animation value.
 







 
 o SetValueBoolean


  
  public virtual   SetValueBoolean( const  iValue)  



  


Role: Set a boolean value. This method set the boolean value
 associated with this animation value object.



  
 Parameters:
  

    

    
 oValues
   
 [out] The list of values.




  
 Returns: 
  
     An HRESULT value.
   
Legal values:
   

     
S_OK
The values are successfully retrieved.

     
E_NOTIMPL
The method is not supported for this animation
 value.

   

 




 
 o SetValuesDouble


  
  public virtual   SetValuesDouble( const  iValues)  



  


Role: Set all the double values. This method set the list of
 double values associated with this animation value object.



  
 Parameters:
  

    

    
 oValues
   
 [out] The list of values.




  
 Returns: 
  
     An HRESULT value.
   
Legal values:
   

     
S_OK
The values are successfully retrieved.

     
E_NOTIMPL
The method is not supported for this animation
 value.

   

 




 
 o SetValuesInteger


  
  public virtual   SetValuesInteger( const  iValues)  



  


Role: Set all the integer values. This method set the list of
 integer values associated with this animation value object.



  
 Parameters:
  

    

    
 oValues
   
 [out] The list of values.




  
 Returns: 
  
     An HRESULT value.
   
Legal values:
   

     
S_OK
The values are successfully retrieved.

     
E_NOTIMPL
The method is not supported for this animation
 value.

   

 




 
 o SetValuesString


  
  public virtual   SetValuesString( const  iValues)  



  


Role: Set all the string values. This method set the list of
 string values associated with this animation value object.



  
 Parameters:
  

    

    
 oValues
   
 [out] The list of values.




  
 Returns: 
  
     An HRESULT value.
   
Legal values:
   

     
S_OK
The values are successfully retrieved.

     
E_NOTIMPL
The method is not supported for this animation
 value.

   

 




 
 o SetVariantLineValue


  
  public virtual   SetVariantLineValue( iVariantValue)  



  


Role: Sets the variant value. The variant value is the
 index used for animation. It is paired with the actual animation values.



  
 Parameters:
  

    

    
 oVariantLine
   
 [out] The time line value is expressed in MKS unit.
 









 This object is included in the file: CATIAnimationValue.h

If needed, your Imakefile.mk should include the module: SIMAnimationStandardItf


Copyright © 1999-2014, Dassault Systèmes. All rights reserved.