< Home

< Table of Contents

REFERENCE MANUAL

HPS.Publish.ImageKit Class Reference

The ImageKit class is a user space object. More...

Inheritance diagram for HPS.Publish.ImageKit:
HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ImageKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.ImageKit in_kit)
 Check if the source ImageKit is equivalent to this ImageKit. More...
 
override int GetHashCode ()
 
 ImageKit ()
 The default constructor creates an empty ImageKit object. More...
 
 ImageKit (HPS.Publish.ImageKit in_kit)
 The copy constructor creates a new ImageKit object that contains the same settings as the source ImageKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.Publish.ImageKit in_kit)
 Copies the source ImageKit into this ImageKit. More...
 
HPS.Publish.ImageKit SetFile (string in_filename)
 Sets the file for the image. More...
 
HPS.Publish.ImageKit SetFormat (HPS.Publish.Image.Format in_format)
 Sets the format of the image. More...
 
HPS.Publish.ImageKit SetSize (int in_width, int in_height)
 Sets the size of the image in pixels. More...
 
void Show (out HPS.Publish.ImageKit out_kit)
 Copies this ImageKit into the given ImageKit. More...
 
bool ShowFile (out string out_filename)
 Shows the file setting. More...
 
bool ShowFormat (out HPS.Publish.Image.Format out_format)
 Shows the format setting. More...
 
bool ShowSize (out int out_width, out int out_height)
 Shows the size setting. More...
 
HPS.Publish.ImageKit UnsetEverything ()
 Removes all data from the image. More...
 
HPS.Publish.ImageKit UnsetFile ()
 Removes the file from the image. More...
 
HPS.Publish.ImageKit UnsetFormat ()
 Removes the format from the image. More...
 
HPS.Publish.ImageKit UnsetSize ()
 Removes the size from the image. More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static bool operator!= (HPS.Publish.ImageKit a, HPS.Publish.ImageKit b)
 
static bool operator== (HPS.Publish.ImageKit a, HPS.Publish.ImageKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The ImageKit class is a user space object.

It acts as the container for all data that can be used to specify an image for a Publish PDF.

Constructor & Destructor Documentation

HPS.Publish.ImageKit.ImageKit ( )

The default constructor creates an empty ImageKit object.

HPS.Publish.ImageKit.ImageKit ( HPS.Publish.ImageKit  in_kit)

The copy constructor creates a new ImageKit object that contains the same settings as the source ImageKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_image_kit" kindref="compound">ImageKit</ref> to copy.

Member Function Documentation

override bool HPS.Publish.ImageKit.Empty ( )
virtual

Indicates whether this ImageKit has any values set on it.

Returns
true if no values are set on this ImageKit, false otherwise.

Reimplemented from HPS.Object.

bool HPS.Publish.ImageKit.Equals ( HPS.Publish.ImageKit  in_kit)

Check if the source ImageKit is equivalent to this ImageKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_image_kit" kindref="compound">ImageKit</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_image_kit" kindref="compound">ImageKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.Publish.ImageKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.Publish.ImageKit.Set ( HPS.Publish.ImageKit  in_kit)

Copies the source ImageKit into this ImageKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_publish_1_1_image_kit" kindref="compound">ImageKit</ref> to copy.
HPS.Publish.ImageKit HPS.Publish.ImageKit.SetFile ( string  in_filename)

Sets the file for the image.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_image_data.html#acfdbde1f6a3d30b89649d2f8550ae4d3">A3DPDFImageData::m_pcFileName</ulink>.

Parameters
in_filenameUTF8-encoded filename for the image.
Returns
A reference to this ImageKit.
HPS.Publish.ImageKit HPS.Publish.ImageKit.SetFormat ( HPS.Publish.Image.Format  in_format)

Sets the format of the image.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_image_data.html#afd7857039238bdeaf53ab9090904402e">A3DPDFImageData::m_eFormat</ulink>.

Parameters
in_formatThe format of the image.
Returns
A reference to this ImageKit.
HPS.Publish.ImageKit HPS.Publish.ImageKit.SetSize ( int  in_width,
int  in_height 
)

Sets the size of the image in pixels.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_image_data.html#a8094c2fae308789cf6dec5a96ab54a3f">A3DPDFImageData::m_iWidth</ulink> and <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f_image_data.html#afd7857039238bdeaf53ab9090904402e">A3DPDFImageData::m_iHeight</ulink>.

Parameters
in_widthThe width of the image in pixels.
in_heightThe height of the image in pixels.
Returns
A reference to this ImageKit.
void HPS.Publish.ImageKit.Show ( out HPS.Publish.ImageKit  out_kit)

Copies this ImageKit into the given ImageKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_publish_1_1_image_kit" kindref="compound">ImageKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_publish_1_1_image_kit" kindref="compound">ImageKit</ref>.
bool HPS.Publish.ImageKit.ShowFile ( out string  out_filename)

Shows the file setting.

Parameters
out_filenameThe filename for the image.
Returns
true if a color was specified, false otherwise.
bool HPS.Publish.ImageKit.ShowFormat ( out HPS.Publish.Image.Format  out_format)

Shows the format setting.

Parameters
out_formatThe format of the image.
Returns
true if a format was specified, false otherwise.
bool HPS.Publish.ImageKit.ShowSize ( out int  out_width,
out int  out_height 
)

Shows the size setting.

Parameters
out_widthThe width of the image in pixels.
out_heightThe height of the image in pixels.
Returns
true if a width and height were specified, false otherwise.
HPS.Publish.ImageKit HPS.Publish.ImageKit.UnsetEverything ( )

Removes all data from the image.

Returns
A reference to this ImageKit.
HPS.Publish.ImageKit HPS.Publish.ImageKit.UnsetFile ( )

Removes the file from the image.

Returns
A reference to this ImageKit.
HPS.Publish.ImageKit HPS.Publish.ImageKit.UnsetFormat ( )

Removes the format from the image.

Returns
A reference to this ImageKit.
HPS.Publish.ImageKit HPS.Publish.ImageKit.UnsetSize ( )

Removes the size from the image.

Returns
A reference to this ImageKit.

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