DD::Image::Info2D Class Reference

Inherits DD::Image::GeneralInfo, and DD::Image::Box.

Inherited by DD::Image::DeepInfo, and DD::Image::IopInfo.

List of all members.

Public Member Functions

 Info2D ()
void setFormats (const FormatPair &formats)
FormatPair formats () const
const Formatformat () const
void format (const Format &v)
const Formatfull_size_format () const
void full_size_format (const Format &v)
const DD::Image::Boxbox () const
DD::Image::Boxbox ()
void setBox (const DD::Image::Box &box)

Detailed Description

This structure contains some of the information that Iop::_validate() and DeepOp::_validate() must calculate. Because this information is often copied unchanged or with tiny variations from the input operator, it is put into this structure so that it can be copied with a single assignment.

This is a subclass of Box and that provides x,y,r,t values that describe the bounding box around all the interesting pixels (that is, the region of definition). It also provides a merge and intersect operators that are useful when _validate is combining the info from two inputs.


Constructor & Destructor Documentation

DD::Image::Info2D::Info2D ( )

constructor


Member Function Documentation

void DD::Image::Info2D::format ( const Format f) [inline]

Sets info_.format() to the given format. Some operators expect this to tell them how to size their output. Most operators will overwrite this in their _validate() method.

const Format & DD::Image::Info2D::full_size_format ( ) const [inline]

If the output of this operator is a proxy for a full size image, this is the full size. Nuke assumes all coordinates are given in the full size and scales them to the format() when storing them into the knob locations. Because Nuke does the scaling most operators can ignore this, it is occasionally useful for undoing the scaling to get the user's original numbers.

If this is not a proxy then this should point at the same location as format().

Referenced by DD::Image::Read::_validate(), DD::Image::Black::Black(), DD::Image::Iop::Iop(), and DD::Image::Reader::Reader().

void DD::Image::Info2D::full_size_format ( const Format f) [inline]

Sets info_.full_size_format() to the given format. Some operators expect this to tell them how to size their output. Most operators will overwrite this in their _validate() method.