XSI::ImageClip

ImageClip Class Reference

As of v4.0, this class is obsolete and is replaced by ImageClip2. More...

#include <xsi_imageclip.h>

Inheritance diagram for ImageClip:

ProjectItem SIObject CBase List of all members.

Public Member Functions
  ImageClip ()
  ~ImageClip ()
  ImageClip (const CRef &in_ref)
  ImageClip (const ImageClip &in_obj)
bool  IsA (siClassID in_ClassID) const
siClassID  GetClassID () const
ImageClip &  operator= (const ImageClip &in_obj)
ImageClip &  operator= (const CRef &in_ref)

Detailed Description

As of v4.0, this class is obsolete and is replaced by ImageClip2.

Deprecated:
4.0 (but plug-ins using this class will continue to run in Softimage).

Constructor & Destructor Documentation

ImageClip (  ) 

Default constructor.

~ImageClip (  ) 

Default destructor.

ImageClip ( const CRef &  in_ref  ) 

Constructor.

Parameters:
in_ref  constant reference object.

ImageClip ( const ImageClip &  in_obj  ) 

Copy constructor.

Parameters:
in_obj  constant class object.

Member Function Documentation

bool IsA ( siClassID  in_ClassID  )  const [virtual]

Returns true if a given class type is compatible with this API class.

Parameters:
in_ClassID  class type.
Returns:
true if the class is compatible, false otherwise.

Reimplemented from ProjectItem.

siClassID GetClassID (  )  const [virtual]

Returns the type of the API class.

Returns:
The class type.

Reimplemented from ProjectItem.

ImageClip& operator= ( const ImageClip &  in_obj  ) 

Creates an object from another object. The newly created object is set to empty if the input object is not compatible.

Parameters:
in_obj  constant class object.
Returns:
The new ImageClip object.

ImageClip& operator= ( const CRef &  in_ref  ) 

Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.

Parameters:
in_ref  constant class object.
Returns:
The new ImageClip object.

Reimplemented from ProjectItem.

The documentation for this class was generated from the following file: