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. More...
Public Member Functions | |
AnnotationKit () | |
The default constructor creates an empty AnnotationKit object. 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. This does not necessarily give the true type of the underlying object. 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. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a984cbf6fbf923367efc14693539a77fa">A3DPDF3DAnnotData::m_eActivateWhen</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#af18f6ede1a64e78217d550f1fd8296a0">A3DPDF3DAnnotData::m_p3DArtwork</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a7c94d67d1af04a1c8ca0a448f7359c8f">A3DPDF3DAnnotData::m_sBackgroundColor</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a5db0afe2ae549413bf18032bdaf6f3cf">A3DPDF3DAnnotData::m_iAppearanceBorderWidth</ulink>. 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. 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/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gaeb2b809a03a348e88808edb5864542ba">A3DPDFDefineViewCarousel</ulink>. More... | |
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/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gaeb2b809a03a348e88808edb5864542ba">A3DPDFDefineViewCarousel</ulink>. More... | |
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/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gaeb2b809a03a348e88808edb5864542ba">A3DPDFDefineViewCarousel</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a2e9c3a5c377dbec3da13497bf0c77a7c">A3DPDF3DAnnotData::m_eDesactiveWhen</ulink>. 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. This corresponds to the (negated) value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#aead487a8b5b64330bfe6481a14ab23cc">A3DPDF3DAnnotData::m_bDisableInteractivity</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a82fa249186ff5bc4027b81252339fd7e">A3DPDF3DAnnotData::m_eLighting</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a630c6fdbe19fd64733d9a4870f087d71">A3DPDF3DAnnotData::m_bOpenModelTree</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a8d289e535b78fd163cc20db1993a4d94">A3DPDF3DAnnotData::m_pcName</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#aebe3e915ab9a18a3068756a9c0677a6d">A3DPDF3DAnnotData::m_pPosterImage</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_r_w_params_export_prc_data.html#aa8435b8348b8d6f1c11f1bc15313ed47">A3DRWParamsExportPrcData::m_bRemoveAttributes</ulink>. 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. 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/publish/latest/build/api_ref/struct_a3_d_r_w_params_export_prc_data.html#afbbe41721d6878768a624ea8d0894531">A3DRWParamsExportPrcData::m_bCompressBrep</ulink> and <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_r_w_params_export_prc_data.html#afd35a9e2bea37b388227b76e14f49daa">A3DRWParamsExportPrcData::m_eCompressBrepType</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_r_w_params_export_prc_data.html#a7a61340a38925e02b30cb67f39b1fcd4">A3DRWParamsExportPrcData::m_bRemoveBRep</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_r_w_params_export_prc_data.html#ae1cf4104a5eda56ce958e94ee1c1c42c">A3DRWParamsExportPrcData::m_bCompressTessellation</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#aa2a03514e90a430f594fc7ece0dcd820">A3DPDF3DAnnotData::m_eRenderingStyle</ulink>. More... | |
HPS.Publish.AnnotationKit | SetSource (HPS.CADModel in_cad_model) |
Sets the source for the annotation to Annotation::SourceType::CADModel. This is the CADModel which contains the 3D data to be exported into the annotation More... | |
HPS.Publish.AnnotationKit | SetSource (HPS.KeyPath[] in_sources) |
Sets the source for the annotation to Annotation::SourceType::KeyPaths. These are the KeyPaths that will be used to locate the 3D data for the annotation. More... | |
HPS.Publish.AnnotationKit | SetSource (HPS.KeyPath in_source) |
Sets the source for the annotation to Annotation::SourceType::KeyPaths. The Key Path that will be used to locate the 3D data for the annotation. More... | |
HPS.Publish.AnnotationKit | SetSource (HPS.CADModel in_cad_model, HPS.KeyPath[] in_additional_sources) |
Sets the source for the annotation to Annotation::SourceType::CADModelAndKeyPaths. These are the CADModel which will be used to export 3D data to the annotation, and the KeyPaths which will be added to the model More... | |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a6713e01011a2440fb0b497174bf356f2">A3DPDF3DAnnotData::m_bShowToolbar</ulink>. More... | |
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/publish/latest/build/api_ref/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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a447c6ec9653b67dda1dce97f0484d69d">A3DPDF3DAnnotData::m_bTransparentBackground</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_r_w_params_export_u3_d_data.html#ae9321a865749efe613aa1d141dff426b">A3DRWParamsExportU3DData::m_ucMeshQualityValue</ulink>. More... | |
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/publish/latest/build/api_ref/struct_a3_d_r_w_params_export_u3_d_data.html#ae7d0446b90139bee7ccf7d0eef4a7204">A3DRWParamsExportU3DData::m_eU3DVersion</ulink>. 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.Publish.Annotation.SourceType out_source_type, out HPS.CADModel out_cad_model, out HPS.KeyPath[] out_key_paths) |
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. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
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. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static HPS.Publish.AnnotationKit | GetDefault () |
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. 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 | |
![]() | |
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.
|
inline |
The default constructor creates an empty AnnotationKit object.
|
inline |
The copy constructor creates a new AnnotationKit object that contains the same settings as the source AnnotationKit.
in_kit | The source AnnotationKit to copy. |
|
inlinevirtual |
Indicates whether this AnnotationKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source AnnotationKit is equivalent to this AnnotationKit.
in_kit | The source AnnotationKit to compare to this AnnotationKit. |
|
inlinestatic |
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.
|
inlinevirtual |
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.
|
inline |
Copies the source AnnotationKit into this AnnotationKit.
in_kit | The source AnnotationKit to copy. |
|
inline |
Sets when the annotation is activated. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a984cbf6fbf923367efc14693539a77fa">A3DPDF3DAnnotData::m_eActivateWhen</ulink>.
in_when | When the annotation is activated. |
|
inline |
Sets the artwork for the annotation. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#af18f6ede1a64e78217d550f1fd8296a0">A3DPDF3DAnnotData::m_p3DArtwork</ulink>.
in_artwork | The artwork for the annotation. |
|
inline |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a7c94d67d1af04a1c8ca0a448f7359c8f">A3DPDF3DAnnotData::m_sBackgroundColor</ulink>.
in_color | The background color for the annotation. |
|
inline |
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/publish/latest/build/api_ref/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. |
|
inline |
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/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gaeb2b809a03a348e88808edb5864542ba">A3DPDFDefineViewCarousel</ulink>.
in_button_names | 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. |
|
inline |
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/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gaeb2b809a03a348e88808edb5864542ba">A3DPDFDefineViewCarousel</ulink>.
in_indices | Indices of the views on the associated ArtworkKit 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
|
inline |
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/publish/latest/build/api_ref/group__a3d__publish__document__module.html#gaeb2b809a03a348e88808edb5864542ba">A3DPDFDefineViewCarousel</ulink>.
in_indices | Indices of the views on the associated ArtworkKit to use for the view carousel. |
SetArtwork
|
inline |
Sets when the annotation is deactivated. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a2e9c3a5c377dbec3da13497bf0c77a7c">A3DPDF3DAnnotData::m_eDesactiveWhen</ulink>.
in_when | When the annotation is deactivated. |
|
inline |
Sets the format of the 3D data for the annotation.
in_format | The format of the 3D data for the annotation. |
|
inline |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#aead487a8b5b64330bfe6481a14ab23cc">A3DPDF3DAnnotData::m_bDisableInteractivity</ulink>.
in_state | Whether to enable interactivity on the annotation. |
|
inline |
Sets the lighting mode for the annotation. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a82fa249186ff5bc4027b81252339fd7e">A3DPDF3DAnnotData::m_eLighting</ulink>.
in_mode | The lighting mode for the annotation. |
|
inline |
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/publish/latest/build/api_ref/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. |
|
inline |
Sets the name for the annotation. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a8d289e535b78fd163cc20db1993a4d94">A3DPDF3DAnnotData::m_pcName</ulink>.
in_name | UTF8-encoded name for the annotation. |
|
inline |
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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#aebe3e915ab9a18a3068756a9c0677a6d">A3DPDF3DAnnotData::m_pPosterImage</ulink>.
in_image | The poster image for the annotation. |
|
inline |
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/publish/latest/build/api_ref/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 PRC data for this annotation. |
|
inline |
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/publish/latest/build/api_ref/struct_a3_d_r_w_params_export_prc_data.html#afbbe41721d6878768a624ea8d0894531">A3DRWParamsExportPrcData::m_bCompressBrep</ulink> and <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/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 PRC annotation. |
|
inline |
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/publish/latest/build/api_ref/struct_a3_d_r_w_params_export_prc_data.html#a7a61340a38925e02b30cb67f39b1fcd4">A3DRWParamsExportPrcData::m_bRemoveBRep</ulink>.
in_state | Whether to remove BRep information in the PRC data for this annotation. |
|
inline |
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/publish/latest/build/api_ref/struct_a3_d_r_w_params_export_prc_data.html#ae1cf4104a5eda56ce958e94ee1c1c42c">A3DRWParamsExportPrcData::m_bCompressTessellation</ulink>.
in_state | Whether to compress tessellation for a PRC annotation. |
|
inline |
Sets the rendering mode for the annotation. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#aa2a03514e90a430f594fc7ece0dcd820">A3DPDF3DAnnotData::m_eRenderingStyle</ulink>.
in_mode | The rendering mode for the annotation. |
|
inline |
Sets the source for the annotation to Annotation::SourceType::CADModel. This is the CADModel which contains the 3D data to be exported into the annotation
in_cad_model | The source CADModel for the annotation. |
|
inline |
Sets the source for the annotation to Annotation::SourceType::KeyPaths. These are the KeyPaths that will be used to locate the 3D data for the annotation.
in_sources | The source KeyPaths for the annotation. |
|
inline |
Sets the source for the annotation to Annotation::SourceType::KeyPaths. The Key Path that will be used to locate the 3D data for the annotation.
in_source | The source KeyPath for the annotation. |
|
inline |
Sets the source for the annotation to Annotation::SourceType::CADModelAndKeyPaths. These are the CADModel which will be used to export 3D data to the annotation, and the KeyPaths which will be added to the model
in_cad_model | The source CADModel for the annotation. |
in_additional_sources | The additional source KeyPaths for the annotation. |
|
inline |
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/publish/latest/build/api_ref/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. |
|
inline |
Sets whether the annotation background is transparent. This will render background color irrelevant and has negative <ulink url="http://docs.techsoft3d.com/publish/latest/build/api_ref/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/publish/latest/build/api_ref/struct_a3_d_p_d_f3_d_annot_data.html#a447c6ec9653b67dda1dce97f0484d69d">A3DPDF3DAnnotData::m_bTransparentBackground</ulink>.
in_state | Whether the annotation background is transparent. |
|
inline |
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/publish/latest/build/api_ref/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 U3D annotation. This value should be in the range [0, 100]. |
|
inline |
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/publish/latest/build/api_ref/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 U3D annotation. |
|
inline |
Copies this AnnotationKit into the given AnnotationKit.
out_kit | The AnnotationKit to populate with the contents of this AnnotationKit. |
|
inline |
Shows the activation setting.
out_when | When the annotation is activated. |
|
inline |
Shows the artwork setting.
out_artwork | The artwork for the annotation. |
|
inline |
Shows the background color setting.
out_color | The background color for the annotation. |
|
inline |
Shows the border width setting.
out_width | The border width of the annotation. |
|
inline |
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. |
|
inline |
Shows the carousel views setting.
out_indices | Indices of the views on the associated ArtworkKit 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. |
|
inline |
Shows the deactivation setting.
out_when | When the annotation is deactivated. |
|
inline |
Shows the format setting.
out_format | The format of the 3D data for the annotation. |
|
inline |
Shows the interactivity setting.
out_state | Whether to enable interactivity on the annotation. |
|
inline |
Shows the lighting mode setting.
out_mode | The lighting mode for the annotation. |
|
inline |
Shows the model tree visibility setting.
out_state | Whether to display the model tree when the annotation is activated. |
|
inline |
Shows the name setting.
out_name | The name for the annotation. |
|
inline |
Shows the poster image setting.
out_image | The poster image for the annotation. |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Shows the rendering mode setting.
out_mode | The rendering mode for the annotation. |
|
inline |
Shows the source setting.
out_source_type | Specifies which one of the previous arguments is valid |
out_cad_model | The source CADModel for the annotation. Only valid if out_source_type is CADModel or CADModelAndKeyPath |
out_key_paths | The source KeyPath array for the annotation. Only valid if out_source_type is KeyPath or CADModelAndKeyPath |
|
inline |
Shows the toolbar visibility setting.
out_state | Whether to display the toolbar when the annotation is activated. |
|
inline |
Shows the transparent background setting.
out_state | Whether the annotation has a transparent background. |
|
inline |
|
inline |
|
inline |
Removes the activation setting.
|
inline |
Removes the artwork setting.
|
inline |
Removes the background color setting.
|
inline |
Removes the border width setting.
|
inline |
Removes the carousel buttons setting.
|
inline |
Removes the carousel views setting.
|
inline |
Removes the deactivation setting.
|
inline |
Removes all data on the annotation.
|
inline |
Removes the format setting.
|
inline |
Removes the interactivity setting.
|
inline |
Removes the lighting mode setting.a
|
inline |
Removes the model tree visibility setting.
|
inline |
Removes the name setting.
|
inline |
Removes the poster image setting.
|
inline |
Removes the attribute removal for PRC data setting.
|
inline |
Removes the BRep compression level for PRC data setting.
|
inline |
Removes the BRep removal for PRC data setting.
|
inline |
Removes the tessellation compression for PRC data setting.
|
inline |
Removes the rendering mode setting.
|
inline |
Removes the source setting.
|
inline |
Removes the toolbar visibility setting.
|
inline |
Removes the transparent background setting.
|
inline |
Removes the compression level for U3D data setting.
|
inline |
Removes the version for U3D data setting.