REFERENCE MANUAL
The ImageKit class is a user space object. More...
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... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
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 IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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.
HPS.Publish.ImageKit.ImageKit | ( | ) |
The default constructor creates an empty ImageKit object.
HPS.Publish.ImageKit.ImageKit | ( | HPS.Publish.ImageKit | in_kit | ) |
|
virtual |
Indicates whether this ImageKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.Publish.ImageKit.Equals | ( | HPS.Publish.ImageKit | in_kit | ) |
Check if the source ImageKit is equivalent to this ImageKit.
in_kit | The 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>. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.Publish.ImageKit.Set | ( | HPS.Publish.ImageKit | in_kit | ) |
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>.
in_filename | UTF8-encoded filename for the image. |
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>.
in_format | The format of the image. |
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>.
in_width | The width of the image in pixels. |
in_height | The height of the image in pixels. |
void HPS.Publish.ImageKit.Show | ( | out HPS.Publish.ImageKit | out_kit | ) |
bool HPS.Publish.ImageKit.ShowFile | ( | out string | out_filename | ) |
Shows the file setting.
out_filename | The filename for the image. |
bool HPS.Publish.ImageKit.ShowFormat | ( | out HPS.Publish.Image.Format | out_format | ) |
Shows the format setting.
out_format | The format of the image. |
bool HPS.Publish.ImageKit.ShowSize | ( | out int | out_width, |
out int | out_height | ||
) |
Shows the size setting.
out_width | The width of the image in pixels. |
out_height | The height of the image in pixels. |
HPS.Publish.ImageKit HPS.Publish.ImageKit.UnsetEverything | ( | ) |
Removes all data from the image.
HPS.Publish.ImageKit HPS.Publish.ImageKit.UnsetFile | ( | ) |
Removes the file from the image.
HPS.Publish.ImageKit HPS.Publish.ImageKit.UnsetFormat | ( | ) |
Removes the format from the image.
HPS.Publish.ImageKit HPS.Publish.ImageKit.UnsetSize | ( | ) |
Removes the size from the image.