REFERENCE MANUAL
The AnnotationKit class is a user space object. More...
Public Member Functions | |
AnnotationKit () | |
The default constructor creates an empty AnnotationKit object. More... | |
AnnotationKit (HPS.SprocketPath in_source) | |
This constructor creates a new AnnotationKit object with the given SprocketPath as the source. More... | |
AnnotationKit (HPS.Publish.AnnotationKit in_kit) | |
The copy constructor creates a new AnnotationKit object that contains the same settings as the source AnnotationKit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this AnnotationKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Publish.AnnotationKit in_kit) |
Check if the source AnnotationKit is equivalent to this AnnotationKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.Publish.AnnotationKit in_kit) |
Copies the source AnnotationKit into this AnnotationKit. More... | |
HPS.Publish.AnnotationKit | SetActivation (HPS.Publish.Activation.When in_when) |
Sets when the annotation is activated. More... | |
HPS.Publish.AnnotationKit | SetArtwork (HPS.Publish.ArtworkKit in_artwork) |
Sets the artwork for the annotation. More... | |
HPS.Publish.AnnotationKit | SetBackgroundColor (HPS.RGBColor in_color) |
Sets the background color for the annotation. More... | |
HPS.Publish.AnnotationKit | SetBorderWidth (int in_width) |
Sets the border width in points for the annotation. More... | |
HPS.Publish.AnnotationKit | SetCarouselButtons (string[] in_button_names, string in_previous_button_name, string in_next_button_name, ulong in_scroll_size) |
Sets the carousel buttons for the annotation. More... | |
HPS.Publish.AnnotationKit | SetCarouselViews (ulong[] in_indices, HPS.Publish.ImageKit[] in_images) |
Sets the carousel views for the annotation. More... | |
HPS.Publish.AnnotationKit | SetCarouselViews (ulong[] in_indices) |
Sets the carousel views for the annotation. More... | |
HPS.Publish.AnnotationKit | SetDeactivation (HPS.Publish.Deactivation.When in_when) |
Sets when the annotation is deactivated. More... | |
HPS.Publish.AnnotationKit | SetFormat (HPS.Publish.Annotation.Format in_format) |
Sets the format of the 3D data for the annotation. More... | |
HPS.Publish.AnnotationKit | SetInteractivity (bool in_state) |
Sets whether to enable interactivity on the annotation. More... | |
HPS.Publish.AnnotationKit | SetLighting (HPS.Publish.Lighting.Mode in_mode) |
Sets the lighting mode for the annotation. More... | |
HPS.Publish.AnnotationKit | SetModelTreeVisibility (bool in_state) |
Sets whether to display the model tree when the annotation is activated. More... | |
HPS.Publish.AnnotationKit | SetName (string in_name) |
Sets the name for the annotation. More... | |
HPS.Publish.AnnotationKit | SetPosterImage (HPS.Publish.ImageKit in_image) |
Sets the poster image for the annotation. More... | |
HPS.Publish.AnnotationKit | SetPRCAttributeRemoval (bool in_state) |
Sets whether to remove the attribute information in the PRC data for this annotation. More... | |
HPS.Publish.AnnotationKit | SetPRCBRepCompression (HPS.Publish.PRC.BRepCompression in_level) |
Sets the level of compression to apply to BRep data for a PRC annotation. More... | |
HPS.Publish.AnnotationKit | SetPRCBRepRemoval (bool in_state) |
Sets whether to remove the BRep information in the PRC data for this annotation. More... | |
HPS.Publish.AnnotationKit | SetPRCTessellationCompression (bool in_state) |
Sets whether to compress tessellation for a PRC annotation. More... | |
HPS.Publish.AnnotationKit | SetRendering (HPS.Publish.Rendering.Mode in_mode) |
Sets the rendering mode for the annotation. More... | |
HPS.Publish.AnnotationKit | SetSource (HPS.SprocketPath in_source) |
Sets the source for the annotation. More... | |
HPS.Publish.AnnotationKit | SetToolbarVisibility (bool in_state) |
Sets whether to display the toolbar when the annotation is activated. More... | |
HPS.Publish.AnnotationKit | SetTransparentBackground (bool in_state) |
Sets whether the annotation background is transparent. More... | |
HPS.Publish.AnnotationKit | SetU3DCompression (byte in_level) |
Sets the level of compression to apply to tessellations for a U3D annotation. More... | |
HPS.Publish.AnnotationKit | SetU3DVersion (HPS.Publish.U3D.Version in_version) |
Sets the version of the data for a U3D annotation. More... | |
void | Show (out HPS.Publish.AnnotationKit out_kit) |
Copies this AnnotationKit into the given AnnotationKit. More... | |
bool | ShowActivation (out HPS.Publish.Activation.When out_when) |
Shows the activation setting. More... | |
bool | ShowArtwork (out HPS.Publish.ArtworkKit out_artwork) |
Shows the artwork setting. More... | |
bool | ShowBackgroundColor (out HPS.RGBColor out_color) |
Shows the background color setting. More... | |
bool | ShowBorderWidth (out int out_width) |
Shows the border width setting. More... | |
bool | ShowCarouselButtons (out string[] out_button_names, out string out_previous_button_name, out string out_next_button_name, out ulong out_scroll_size) |
Shows the carousel buttons setting. More... | |
bool | ShowCarouselViews (out ulong[] out_indices, out HPS.Publish.ImageKit[] out_images) |
Shows the carousel views setting. More... | |
bool | ShowDeactivation (out HPS.Publish.Deactivation.When out_when) |
Shows the deactivation setting. More... | |
bool | ShowFormat (out HPS.Publish.Annotation.Format out_format) |
Shows the format setting. More... | |
bool | ShowInteractivity (out bool out_state) |
Shows the interactivity setting. More... | |
bool | ShowLighting (out HPS.Publish.Lighting.Mode out_mode) |
Shows the lighting mode setting. More... | |
bool | ShowModelTreeVisibility (out bool out_state) |
Shows the model tree visibility setting. More... | |
bool | ShowName (out string out_name) |
Shows the name setting. More... | |
bool | ShowPosterImage (out HPS.Publish.ImageKit out_image) |
Shows the poster image setting. More... | |
bool | ShowPRCAttributeRemoval (out bool out_state) |
Shows the attribute removal for PRC data setting. More... | |
bool | ShowPRCBRepCompression (out HPS.Publish.PRC.BRepCompression out_level) |
Shows the BRep compression level for PRC data setting. More... | |
bool | ShowPRCBRepRemoval (out bool out_state) |
Shows the BRep removal for PRC data setting. More... | |
bool | ShowPRCTessellationCompression (out bool out_state) |
Shows the tessellation compression for PRC data setting. More... | |
bool | ShowRendering (out HPS.Publish.Rendering.Mode out_mode) |
Shows the rendering mode setting. More... | |
bool | ShowSource (out HPS.SprocketPath out_source) |
Shows the source setting. More... | |
bool | ShowToolbarVisibility (out bool out_state) |
Shows the toolbar visibility setting. More... | |
bool | ShowTransparentBackground (out bool out_state) |
Shows the transparent background setting. More... | |
bool | ShowU3DCompression (out byte out_level) |
Shows the compression level for U3D data for the annotation. More... | |
bool | ShowU3DVersion (out HPS.Publish.U3D.Version out_version) |
Shows the version for U3D data setting. More... | |
HPS.Publish.AnnotationKit | UnsetActivation () |
Removes the activation setting. More... | |
HPS.Publish.AnnotationKit | UnsetArtwork () |
Removes the artwork setting. More... | |
HPS.Publish.AnnotationKit | UnsetBackgroundColor () |
Removes the background color setting. More... | |
HPS.Publish.AnnotationKit | UnsetBorderWidth () |
Removes the border width setting. More... | |
HPS.Publish.AnnotationKit | UnsetCarouselButtons () |
Removes the carousel buttons setting. More... | |
HPS.Publish.AnnotationKit | UnsetCarouselViews () |
Removes the carousel views setting. More... | |
HPS.Publish.AnnotationKit | UnsetDeactivation () |
Removes the deactivation setting. More... | |
HPS.Publish.AnnotationKit | UnsetEverything () |
Removes all data on the annotation. More... | |
HPS.Publish.AnnotationKit | UnsetFormat () |
Removes the format setting. More... | |
HPS.Publish.AnnotationKit | UnsetInteractivity () |
Removes the interactivity setting. More... | |
HPS.Publish.AnnotationKit | UnsetLighting () |
Removes the lighting mode setting.a More... | |
HPS.Publish.AnnotationKit | UnsetModelTreeVisibility () |
Removes the model tree visibility setting. More... | |
HPS.Publish.AnnotationKit | UnsetName () |
Removes the name setting. More... | |
HPS.Publish.AnnotationKit | UnsetPosterImage () |
Removes the poster image setting. More... | |
HPS.Publish.AnnotationKit | UnsetPRCAttributeRemoval () |
Removes the attribute removal for PRC data setting. More... | |
HPS.Publish.AnnotationKit | UnsetPRCBRepCompression () |
Removes the BRep compression level for PRC data setting. More... | |
HPS.Publish.AnnotationKit | UnsetPRCBRepRemoval () |
Removes the BRep removal for PRC data setting. More... | |
HPS.Publish.AnnotationKit | UnsetPRCTessellationCompression () |
Removes the tessellation compression for PRC data setting. More... | |
HPS.Publish.AnnotationKit | UnsetRendering () |
Removes the rendering mode setting. More... | |
HPS.Publish.AnnotationKit | UnsetSource () |
Removes the source setting. More... | |
HPS.Publish.AnnotationKit | UnsetToolbarVisibility () |
Removes the toolbar visibility setting. More... | |
HPS.Publish.AnnotationKit | UnsetTransparentBackground () |
Removes the transparent background setting. More... | |
HPS.Publish.AnnotationKit | UnsetU3DCompression () |
Removes the compression level for U3D data setting. More... | |
HPS.Publish.AnnotationKit | UnsetU3DVersion () |
Removes the version for U3D data setting. 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 HPS.Publish.AnnotationKit | GetDefault () |
Creates a AnnotationKit which contains the default settings. More... | |
static bool | operator!= (HPS.Publish.AnnotationKit a, HPS.Publish.AnnotationKit b) |
static bool | operator== (HPS.Publish.AnnotationKit a, HPS.Publish.AnnotationKit 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 AnnotationKit class is a user space object.
It acts as the container for all data that can be on an annotation in a Publish PDF.
HPS.Publish.AnnotationKit.AnnotationKit | ( | ) |
The default constructor creates an empty AnnotationKit object.
HPS.Publish.AnnotationKit.AnnotationKit | ( | HPS.SprocketPath | in_source | ) |
This constructor creates a new AnnotationKit object with the given SprocketPath as the source.
in_source | The source SprocketPath for the annotation. |
HPS.Publish.AnnotationKit.AnnotationKit | ( | HPS.Publish.AnnotationKit | in_kit | ) |
The copy constructor creates a new AnnotationKit object that contains the same settings as the source AnnotationKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_annotation_kit" kindref="compound">AnnotationKit</ref> to copy. |
|
virtual |
Indicates whether this AnnotationKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.Publish.AnnotationKit.Equals | ( | HPS.Publish.AnnotationKit | in_kit | ) |
Check if the source AnnotationKit is equivalent to this AnnotationKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_annotation_kit" kindref="compound">AnnotationKit</ref> to compare to this <ref refid="class_h_p_s_1_1_publish_1_1_annotation_kit" kindref="compound">AnnotationKit</ref>. |
|
static |
Creates a AnnotationKit which contains the default settings.
The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for export unless a setting is overridden by the AnnotationKit passed to File::Export.
|
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.AnnotationKit.Set | ( | HPS.Publish.AnnotationKit | in_kit | ) |
Copies the source AnnotationKit into this AnnotationKit.
in_kit | The source <ref refid="class_h_p_s_1_1_publish_1_1_annotation_kit" kindref="compound">AnnotationKit</ref> to copy. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetActivation | ( | HPS.Publish.Activation.When | in_when | ) |
Sets when the annotation is activated.
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_f3_d_annot_data.html#a984cbf6fbf923367efc14693539a77fa">A3DPDF3DAnnotData::m_eActivateWhen</ulink>.
in_when | When the annotation is activated. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetArtwork | ( | HPS.Publish.ArtworkKit | in_artwork | ) |
Sets the artwork for the annotation.
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_f3_d_annot_data.html#af18f6ede1a64e78217d550f1fd8296a0">A3DPDF3DAnnotData::m_p3DArtwork</ulink>.
in_artwork | The artwork for the annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetBackgroundColor | ( | HPS.RGBColor | in_color | ) |
Sets the background color for the annotation.
Unused if there is a transparent background. 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_f3_d_annot_data.html#a7c94d67d1af04a1c8ca0a448f7359c8f">A3DPDF3DAnnotData::m_sBackgroundColor</ulink>.
in_color | The background color for the annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetBorderWidth | ( | int | in_width | ) |
Sets the border width in points for the annotation.
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_f3_d_annot_data.html#a5db0afe2ae549413bf18032bdaf6f3cf">A3DPDF3DAnnotData::m_iAppearanceBorderWidth</ulink>.
in_width | The border width in points for the annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetCarouselButtons | ( | string[] | in_button_names, |
string | in_previous_button_name, | ||
string | in_next_button_name, | ||
ulong | in_scroll_size | ||
) |
Sets the carousel buttons for the annotation.
This must be specified for a view carousel to be generated. This corresponds to the button names that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#gaeb2b809a03a348e88808edb5864542ba">A3DPDFDefineViewCarousel</ulink>.
in_count | Size of the following array. |
in_button_names | UTF8-encoded names for the view buttons in the carousel. |
in_previous_button_name | UTF8-encoded name for the previous button. |
in_next_button_name | UTF8-encoded name for the next button. |
in_scroll_size | Number of buttons to scroll when the previous or next buttons are pressed. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetCarouselViews | ( | ulong[] | in_indices, |
HPS.Publish.ImageKit[] | in_images | ||
) |
Sets the carousel views for the annotation.
This can be optionally specified for a view carousel. This corresponds to the views and images that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#gaeb2b809a03a348e88808edb5864542ba">A3DPDFDefineViewCarousel</ulink>.
in_count | Size of the following array. |
in_indices | Indices of the views on the associated <ref refid="class_h_p_s_1_1_publish_1_1_artwork_kit" kindref="compound">ArtworkKit</ref> to use for the view carousel. |
in_images | Images to use for the view carousel buttons. If unspecified, images will be generated from the views themselves. |
SetArtwork
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetCarouselViews | ( | ulong[] | in_indices | ) |
Sets the carousel views for the annotation.
This can be optionally specified for a view carousel. This corresponds to the views and images that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/group__a3d__publish__document__module.html#gaeb2b809a03a348e88808edb5864542ba">A3DPDFDefineViewCarousel</ulink>.
in_count | Size of the following array. |
in_indices | Indices of the views on the associated <ref refid="class_h_p_s_1_1_publish_1_1_artwork_kit" kindref="compound">ArtworkKit</ref> to use for the view carousel. |
SetArtwork
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetDeactivation | ( | HPS.Publish.Deactivation.When | in_when | ) |
Sets when the annotation is deactivated.
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_f3_d_annot_data.html#a2e9c3a5c377dbec3da13497bf0c77a7c">A3DPDF3DAnnotData::m_eDesactiveWhen</ulink>.
in_when | When the annotation is deactivated. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetFormat | ( | HPS.Publish.Annotation.Format | in_format | ) |
Sets the format of the 3D data for the annotation.
in_format | The format of the 3D data for the annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetInteractivity | ( | bool | in_state | ) |
Sets whether to enable interactivity on the annotation.
This corresponds to the (negated) value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f3_d_annot_data.html#aead487a8b5b64330bfe6481a14ab23cc">A3DPDF3DAnnotData::m_bDisableInteractivity</ulink>.
in_state | Whether to enable interactivity on the annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetLighting | ( | HPS.Publish.Lighting.Mode | in_mode | ) |
Sets the lighting mode for the annotation.
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_f3_d_annot_data.html#a82fa249186ff5bc4027b81252339fd7e">A3DPDF3DAnnotData::m_eLighting</ulink>.
in_mode | The lighting mode for the annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetModelTreeVisibility | ( | bool | in_state | ) |
Sets whether to display the model tree when the annotation is activated.
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_f3_d_annot_data.html#a630c6fdbe19fd64733d9a4870f087d71">A3DPDF3DAnnotData::m_bOpenModelTree</ulink>.
in_state | Whether to display the model tree when the annotation is activated. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetName | ( | string | in_name | ) |
Sets the name for the annotation.
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_f3_d_annot_data.html#a8d289e535b78fd163cc20db1993a4d94">A3DPDF3DAnnotData::m_pcName</ulink>.
in_name | UTF8-encoded name for the annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetPosterImage | ( | HPS.Publish.ImageKit | in_image | ) |
Sets the poster image for the annotation.
If this is not specified a poster image will be generated by Publish. 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_f3_d_annot_data.html#aebe3e915ab9a18a3068756a9c0677a6d">A3DPDF3DAnnotData::m_pPosterImage</ulink>.
in_image | The poster image for the annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetPRCAttributeRemoval | ( | bool | in_state | ) |
Sets whether to remove the attribute information in the PRC data for this annotation.
This setting is only relevant if the format of the annotation is Annotation::Format::PRC. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_r_w_params_export_prc_data.html#aa8435b8348b8d6f1c11f1bc15313ed47">A3DRWParamsExportPrcData::m_bRemoveAttributes</ulink>.
in_state | Whether to remove the attribute information in the <ref refid="class_h_p_s_1_1_publish_1_1_p_r_c" kindref="compound">PRC</ref> data for this annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetPRCBRepCompression | ( | HPS.Publish.PRC.BRepCompression | in_level | ) |
Sets the level of compression to apply to BRep data for a PRC annotation.
This setting is only relevant if the format of the annotation is Annotation::Format::PRC. This corresponds to the values that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_r_w_params_export_prc_data.html#afbbe41721d6878768a624ea8d0894531">A3DRWParamsExportPrcData::m_bCompressBrep</ulink> and <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_r_w_params_export_prc_data.html#afd35a9e2bea37b388227b76e14f49daa">A3DRWParamsExportPrcData::m_eCompressBrepType</ulink>.
in_level | The level of compression to apply to BRep data for a <ref refid="class_h_p_s_1_1_publish_1_1_p_r_c" kindref="compound">PRC</ref> annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetPRCBRepRemoval | ( | bool | in_state | ) |
Sets whether to remove the BRep information in the PRC data for this annotation.
This setting is only relevant if the format of the annotation is Annotation::Format::PRC. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_r_w_params_export_prc_data.html#a7a61340a38925e02b30cb67f39b1fcd4">A3DRWParamsExportPrcData::m_bRemoveBRep</ulink>.
in_state | Whether to remove BRep information in the <ref refid="class_h_p_s_1_1_publish_1_1_p_r_c" kindref="compound">PRC</ref> data for this annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetPRCTessellationCompression | ( | bool | in_state | ) |
Sets whether to compress tessellation for a PRC annotation.
This setting is only relevant if the format of the annotation is Annotation::Format::PRC. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_r_w_params_export_prc_data.html#ae1cf4104a5eda56ce958e94ee1c1c42c">A3DRWParamsExportPrcData::m_bCompressTessellation</ulink>.
in_state | Whether to compress tessellation for a <ref refid="class_h_p_s_1_1_publish_1_1_p_r_c" kindref="compound">PRC</ref> annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetRendering | ( | HPS.Publish.Rendering.Mode | in_mode | ) |
Sets the rendering mode for the annotation.
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_f3_d_annot_data.html#aa2a03514e90a430f594fc7ece0dcd820">A3DPDF3DAnnotData::m_eRenderingStyle</ulink>.
in_mode | The rendering mode for the annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetSource | ( | HPS.SprocketPath | in_source | ) |
Sets the source for the annotation.
This is the SprocketPath that will be used to locate the 3D data for the annotation.
in_source | The source SprocketPath for the annotation. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetToolbarVisibility | ( | bool | in_state | ) |
Sets whether to display the toolbar when the annotation is activated.
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_f3_d_annot_data.html#a6713e01011a2440fb0b497174bf356f2">A3DPDF3DAnnotData::m_bShowToolbar</ulink>.
in_state | Whether to display the toolbar when the annotation is activated. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetTransparentBackground | ( | bool | in_state | ) |
Sets whether the annotation background is transparent.
This will render background color irrelevant and has negative <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_p_d_f3_d_annot_data.html#a447c6ec9653b67dda1dce97f0484d69d">ramifications</ulink>. 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_f3_d_annot_data.html#a447c6ec9653b67dda1dce97f0484d69d">A3DPDF3DAnnotData::m_bTransparentBackground</ulink>.
in_state | Whether the annotation background is transparent. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetU3DCompression | ( | byte | in_level | ) |
Sets the level of compression to apply to tessellations for a U3D annotation.
If no compression level is set, no compression will be applied. This setting is only relevant if the format of the annotation is Annotation::Format::U3D. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_r_w_params_export_u3_d_data.html#ae9321a865749efe613aa1d141dff426b">A3DRWParamsExportU3DData::m_ucMeshQualityValue</ulink>.
in_level | The level of compression to apply to tessellations for a <ref refid="class_h_p_s_1_1_publish_1_1_u3_d" kindref="compound">U3D</ref> annotation. This value should be in the range [0, 100]. |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetU3DVersion | ( | HPS.Publish.U3D.Version | in_version | ) |
Sets the version of the data for a U3D annotation.
This setting is only relevant if the format of the annotation is Annotation::Format::U3D. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/publish_ref_manual/struct_a3_d_r_w_params_export_u3_d_data.html#ae7d0446b90139bee7ccf7d0eef4a7204">A3DRWParamsExportU3DData::m_eU3DVersion</ulink>.
in_version | The version of the data for a <ref refid="class_h_p_s_1_1_publish_1_1_u3_d" kindref="compound">U3D</ref> annotation. |
void HPS.Publish.AnnotationKit.Show | ( | out HPS.Publish.AnnotationKit | out_kit | ) |
Copies this AnnotationKit into the given AnnotationKit.
out_kit | The <ref refid="class_h_p_s_1_1_publish_1_1_annotation_kit" kindref="compound">AnnotationKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_publish_1_1_annotation_kit" kindref="compound">AnnotationKit</ref>. |
bool HPS.Publish.AnnotationKit.ShowActivation | ( | out HPS.Publish.Activation.When | out_when | ) |
Shows the activation setting.
out_when | When the annotation is activated. |
bool HPS.Publish.AnnotationKit.ShowArtwork | ( | out HPS.Publish.ArtworkKit | out_artwork | ) |
Shows the artwork setting.
out_artwork | The artwork for the annotation. |
bool HPS.Publish.AnnotationKit.ShowBackgroundColor | ( | out HPS.RGBColor | out_color | ) |
Shows the background color setting.
out_color | The background color for the annotation. |
bool HPS.Publish.AnnotationKit.ShowBorderWidth | ( | out int | out_width | ) |
Shows the border width setting.
out_width | The border width of the annotation. |
bool HPS.Publish.AnnotationKit.ShowCarouselButtons | ( | out string[] | out_button_names, |
out string | out_previous_button_name, | ||
out string | out_next_button_name, | ||
out ulong | out_scroll_size | ||
) |
Shows the carousel buttons setting.
out_button_names | Names for the view buttons in the carousel. |
out_previous_button_name | Name for the previous button. |
out_next_button_name | Name for the next button. |
out_scroll_size | Numbers of buttons scrolled when the previous or next buttons are pressed. |
bool HPS.Publish.AnnotationKit.ShowCarouselViews | ( | out ulong[] | out_indices, |
out HPS.Publish.ImageKit[] | out_images | ||
) |
Shows the carousel views setting.
out_indices | Indices of the views on the associated <ref refid="class_h_p_s_1_1_publish_1_1_artwork_kit" kindref="compound">ArtworkKit</ref> to use for the view carousel. |
out_images | Images to use for the view carousel buttons. May be empty, even if out_indices is not. |
bool HPS.Publish.AnnotationKit.ShowDeactivation | ( | out HPS.Publish.Deactivation.When | out_when | ) |
Shows the deactivation setting.
out_when | When the annotation is deactivated. |
bool HPS.Publish.AnnotationKit.ShowFormat | ( | out HPS.Publish.Annotation.Format | out_format | ) |
Shows the format setting.
out_format | The format of the 3D data for the annotation. |
bool HPS.Publish.AnnotationKit.ShowInteractivity | ( | out bool | out_state | ) |
Shows the interactivity setting.
out_state | Whether to enable interactivity on the annotation. |
bool HPS.Publish.AnnotationKit.ShowLighting | ( | out HPS.Publish.Lighting.Mode | out_mode | ) |
Shows the lighting mode setting.
out_mode | The lighting mode for the annotation. |
bool HPS.Publish.AnnotationKit.ShowModelTreeVisibility | ( | out bool | out_state | ) |
Shows the model tree visibility setting.
out_state | Whether to display the model tree when the annotation is activated. |
bool HPS.Publish.AnnotationKit.ShowName | ( | out string | out_name | ) |
Shows the name setting.
out_name | The name for the annotation. |
bool HPS.Publish.AnnotationKit.ShowPosterImage | ( | out HPS.Publish.ImageKit | out_image | ) |
Shows the poster image setting.
out_image | The poster image for the annotation. |
bool HPS.Publish.AnnotationKit.ShowPRCAttributeRemoval | ( | out bool | out_state | ) |
bool HPS.Publish.AnnotationKit.ShowPRCBRepCompression | ( | out HPS.Publish.PRC.BRepCompression | out_level | ) |
bool HPS.Publish.AnnotationKit.ShowPRCBRepRemoval | ( | out bool | out_state | ) |
bool HPS.Publish.AnnotationKit.ShowPRCTessellationCompression | ( | out bool | out_state | ) |
bool HPS.Publish.AnnotationKit.ShowRendering | ( | out HPS.Publish.Rendering.Mode | out_mode | ) |
Shows the rendering mode setting.
out_mode | The rendering mode for the annotation. |
bool HPS.Publish.AnnotationKit.ShowSource | ( | out HPS.SprocketPath | out_source | ) |
Shows the source setting.
out_source | The source SprocketPath for the annotation. |
bool HPS.Publish.AnnotationKit.ShowToolbarVisibility | ( | out bool | out_state | ) |
Shows the toolbar visibility setting.
out_state | Whether to display the toolbar when the annotation is activated. |
bool HPS.Publish.AnnotationKit.ShowTransparentBackground | ( | out bool | out_state | ) |
Shows the transparent background setting.
out_state | Whether the annotation has a transparent background. |
bool HPS.Publish.AnnotationKit.ShowU3DCompression | ( | out byte | out_level | ) |
bool HPS.Publish.AnnotationKit.ShowU3DVersion | ( | out HPS.Publish.U3D.Version | out_version | ) |
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetActivation | ( | ) |
Removes the activation setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetArtwork | ( | ) |
Removes the artwork setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetBackgroundColor | ( | ) |
Removes the background color setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetBorderWidth | ( | ) |
Removes the border width setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetCarouselButtons | ( | ) |
Removes the carousel buttons setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetCarouselViews | ( | ) |
Removes the carousel views setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetDeactivation | ( | ) |
Removes the deactivation setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetEverything | ( | ) |
Removes all data on the annotation.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetFormat | ( | ) |
Removes the format setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetInteractivity | ( | ) |
Removes the interactivity setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetLighting | ( | ) |
Removes the lighting mode setting.a
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetModelTreeVisibility | ( | ) |
Removes the model tree visibility setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetName | ( | ) |
Removes the name setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetPosterImage | ( | ) |
Removes the poster image setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetPRCAttributeRemoval | ( | ) |
Removes the attribute removal for PRC data setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetPRCBRepCompression | ( | ) |
Removes the BRep compression level for PRC data setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetPRCBRepRemoval | ( | ) |
Removes the BRep removal for PRC data setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetPRCTessellationCompression | ( | ) |
Removes the tessellation compression for PRC data setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetRendering | ( | ) |
Removes the rendering mode setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetSource | ( | ) |
Removes the source setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetToolbarVisibility | ( | ) |
Removes the toolbar visibility setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetTransparentBackground | ( | ) |
Removes the transparent background setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetU3DCompression | ( | ) |
Removes the compression level for U3D data setting.
HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetU3DVersion | ( | ) |
Removes the version for U3D data setting.