#include <sprk_publish.h>
Static Public Member Functions | |
static AnnotationKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
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 | ( | SprocketPath const & | 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 | ( | AnnotationKit const & | in_kit | ) |
The copy constructor creates a new AnnotationKit object that contains the same settings as the source AnnotationKit.
in_kit | The source AnnotationKit to copy. |
HPS::Publish::AnnotationKit::AnnotationKit | ( | AnnotationKit && | in_kit | ) |
The move constructor creates an AnnotationKit by transferring the underlying object of the rvalue reference to this AnnotationKit.
in_kit | An rvalue reference to an AnnotationKit to take the underlying object from. |
|
virtual |
Indicates whether this AnnotationKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::Publish::AnnotationKit::Equals | ( | AnnotationKit const & | in_kit | ) | const |
Check if the source AnnotationKit is equivalent to this AnnotationKit.
in_kit | The source AnnotationKit to compare to this AnnotationKit. |
|
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.
|
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.
bool HPS::Publish::AnnotationKit::operator!= | ( | AnnotationKit const & | in_kit | ) | const |
Check if the source AnnotationKit is not equivalent to this AnnotationKit.
in_kit | The source AnnotationKit to compare to this AnnotationKit. |
AnnotationKit& HPS::Publish::AnnotationKit::operator= | ( | AnnotationKit const & | in_kit | ) |
Copies the source AnnotationKit into this AnnotationKit.
in_kit | The source AnnotationKit to copy. |
AnnotationKit& HPS::Publish::AnnotationKit::operator= | ( | AnnotationKit && | in_kit | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this AnnotationKit.
in_kit | An rvalue reference to an AnnotationKit to take the underlying object from. |
bool HPS::Publish::AnnotationKit::operator== | ( | AnnotationKit const & | in_kit | ) | const |
Check if the source AnnotationKit is equivalent to this AnnotationKit.
in_kit | The source AnnotationKit to compare to this AnnotationKit. |
void HPS::Publish::AnnotationKit::Set | ( | AnnotationKit const & | in_kit | ) |
Copies the source AnnotationKit into this AnnotationKit.
in_kit | The source AnnotationKit to copy. |
AnnotationKit& HPS::Publish::AnnotationKit::SetActivation | ( | Activation::When | in_when | ) |
Sets when the annotation is activated. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_eActivateWhen.
in_when | When the annotation is activated. |
AnnotationKit& HPS::Publish::AnnotationKit::SetArtwork | ( | ArtworkKit const & | in_artwork | ) |
Sets the artwork for the annotation. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_p3DArtwork.
in_artwork | The artwork for the annotation. |
AnnotationKit& HPS::Publish::AnnotationKit::SetBackgroundColor | ( | RGBColor const & | 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 A3DPDF3DAnnotData::m_sBackgroundColor.
in_color | The background color for the annotation. |
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 A3DPDF3DAnnotData::m_iAppearanceBorderWidth.
in_width | The border width in points for the annotation. |
AnnotationKit& HPS::Publish::AnnotationKit::SetCarouselButtons | ( | size_t | in_count, |
UTF8 const | in_button_names[], | ||
char const * | in_previous_button_name, | ||
char const * | in_next_button_name, | ||
size_t | 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 A3DPDFDefineViewCarousel.
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. |
AnnotationKit& HPS::Publish::AnnotationKit::SetCarouselButtons | ( | UTF8Array const & | in_button_names, |
char const * | in_previous_button_name, | ||
char const * | in_next_button_name, | ||
size_t | 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 A3DPDFDefineViewCarousel.
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. |
AnnotationKit& HPS::Publish::AnnotationKit::SetCarouselViews | ( | size_t | in_count, |
size_t const | in_indices[], | ||
ImageKit const | in_images[] = nullptr |
||
) |
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 A3DPDFDefineViewCarousel.
in_count | Size of the following array. |
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. |
AnnotationKit& HPS::Publish::AnnotationKit::SetCarouselViews | ( | SizeTArray const & | in_indices, |
ImageKitArray const & | in_images = ImageKitArray() |
||
) |
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 A3DPDFDefineViewCarousel.
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. |
AnnotationKit& HPS::Publish::AnnotationKit::SetDeactivation | ( | Deactivation::When | in_when | ) |
Sets when the annotation is deactivated. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_eDesactiveWhen.
in_when | When the annotation is deactivated. |
AnnotationKit& HPS::Publish::AnnotationKit::SetFormat | ( | 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. |
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 A3DPDF3DAnnotData::m_bDisableInteractivity.
in_state | Whether to enable interactivity on the annotation. |
AnnotationKit& HPS::Publish::AnnotationKit::SetLighting | ( | Lighting::Mode | in_mode | ) |
Sets the lighting mode for the annotation. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_eLighting.
in_mode | The lighting mode for the annotation. |
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 A3DPDF3DAnnotData::m_bOpenModelTree.
in_state | Whether to display the model tree when the annotation is activated. |
AnnotationKit& HPS::Publish::AnnotationKit::SetName | ( | char const * | in_name | ) |
Sets the name for the annotation. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_pcName.
in_name | UTF8-encoded name for the annotation. |
AnnotationKit& HPS::Publish::AnnotationKit::SetPosterImage | ( | ImageKit const & | 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 A3DPDF3DAnnotData::m_pPosterImage.
in_image | The poster image for the annotation. |
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 A3DRWParamsExportPrcData::m_bRemoveAttributes.
in_state | Whether to remove the attribute information in the PRC data for this annotation. |
AnnotationKit& HPS::Publish::AnnotationKit::SetPRCBRepCompression | ( | 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 A3DRWParamsExportPrcData::m_bCompressBrep and A3DRWParamsExportPrcData::m_eCompressBrepType.
in_level | The level of compression to apply to BRep data for a PRC annotation. |
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 A3DRWParamsExportPrcData::m_bRemoveBRep.
in_state | Whether to remove BRep information in the PRC data for this annotation. |
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 A3DRWParamsExportPrcData::m_bCompressTessellation.
in_state | Whether to compress tessellation for a PRC annotation. |
AnnotationKit& HPS::Publish::AnnotationKit::SetRendering | ( | Rendering::Mode | in_mode | ) |
Sets the rendering mode for the annotation. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_eRenderingStyle.
in_mode | The rendering mode for the annotation. |
AnnotationKit& HPS::Publish::AnnotationKit::SetSource | ( | SprocketPath const & | 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. |
AnnotationKit& HPS::Publish::AnnotationKit::SetSource | ( | KeyPath const & | in_source | ) |
Sets the source for the annotation. This is the KeyPath that will be used to locate the 3D data for the annotation.
in_source | The source KeyPath for the annotation. |
AnnotationKit& HPS::Publish::AnnotationKit::SetSource | ( | KeyPathArray const & | in_sources | ) |
Sets the source for the annotation. These are the KeyPaths that will be used to locate the 3D data for the annotation.
in_sources | The source KeyPaths for the annotation. |
AnnotationKit& HPS::Publish::AnnotationKit::SetSource | ( | size_t | in_count, |
KeyPath const | in_sources[] | ||
) |
Sets the source for the annotation. These are the KeyPaths that will be used to locate the 3D data for the annotation.
in_count | The number of elements in in_sources |
in_sources | The source KeyPaths for the annotation. |
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 A3DPDF3DAnnotData::m_bShowToolbar.
in_state | Whether to display the toolbar when the annotation is activated. |
AnnotationKit& HPS::Publish::AnnotationKit::SetTransparentBackground | ( | bool | in_state | ) |
Sets whether the annotation background is transparent. This will render background color irrelevant and has negative ramifications. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_bTransparentBackground.
in_state | Whether the annotation background is transparent. |
AnnotationKit& HPS::Publish::AnnotationKit::SetU3DCompression | ( | unsigned char | 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 A3DRWParamsExportU3DData::m_ucMeshQualityValue.
in_level | The level of compression to apply to tessellations for a U3D annotation. This value should be in the range [0, 100]. |
AnnotationKit& HPS::Publish::AnnotationKit::SetU3DVersion | ( | 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 A3DRWParamsExportU3DData::m_eU3DVersion.
in_version | The version of the data for a U3D annotation. |
void HPS::Publish::AnnotationKit::Show | ( | AnnotationKit & | out_kit | ) | const |
Copies this AnnotationKit into the given AnnotationKit.
out_kit | The AnnotationKit to populate with the contents of this AnnotationKit. |
bool HPS::Publish::AnnotationKit::ShowActivation | ( | Activation::When & | out_when | ) | const |
Shows the activation setting.
out_when | When the annotation is activated. |
bool HPS::Publish::AnnotationKit::ShowArtwork | ( | ArtworkKit & | out_artwork | ) | const |
Shows the artwork setting.
out_artwork | The artwork for the annotation. |
bool HPS::Publish::AnnotationKit::ShowBackgroundColor | ( | RGBColor & | out_color | ) | const |
Shows the background color setting.
out_color | The background color for the annotation. |
bool HPS::Publish::AnnotationKit::ShowBorderWidth | ( | int & | out_width | ) | const |
Shows the border width setting.
out_width | The border width of the annotation. |
bool HPS::Publish::AnnotationKit::ShowCarouselButtons | ( | UTF8Array & | out_button_names, |
UTF8 & | out_previous_button_name, | ||
UTF8 & | out_next_button_name, | ||
size_t & | out_scroll_size | ||
) | const |
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 | ( | SizeTArray & | out_indices, |
ImageKitArray & | out_images | ||
) | const |
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. |
bool HPS::Publish::AnnotationKit::ShowDeactivation | ( | Deactivation::When & | out_when | ) | const |
Shows the deactivation setting.
out_when | When the annotation is deactivated. |
bool HPS::Publish::AnnotationKit::ShowFormat | ( | Annotation::Format & | out_format | ) | const |
Shows the format setting.
out_format | The format of the 3D data for the annotation. |
bool HPS::Publish::AnnotationKit::ShowInteractivity | ( | bool & | out_state | ) | const |
Shows the interactivity setting.
out_state | Whether to enable interactivity on the annotation. |
bool HPS::Publish::AnnotationKit::ShowLighting | ( | Lighting::Mode & | out_mode | ) | const |
Shows the lighting mode setting.
out_mode | The lighting mode for the annotation. |
bool HPS::Publish::AnnotationKit::ShowModelTreeVisibility | ( | bool & | out_state | ) | const |
Shows the model tree visibility setting.
out_state | Whether to display the model tree when the annotation is activated. |
bool HPS::Publish::AnnotationKit::ShowName | ( | UTF8 & | out_name | ) | const |
Shows the name setting.
out_name | The name for the annotation. |
bool HPS::Publish::AnnotationKit::ShowPosterImage | ( | ImageKit & | out_image | ) | const |
Shows the poster image setting.
out_image | The poster image for the annotation. |
bool HPS::Publish::AnnotationKit::ShowPRCAttributeRemoval | ( | bool & | out_state | ) | const |
bool HPS::Publish::AnnotationKit::ShowPRCBRepCompression | ( | PRC::BRepCompression & | out_level | ) | const |
bool HPS::Publish::AnnotationKit::ShowPRCBRepRemoval | ( | bool & | out_state | ) | const |
bool HPS::Publish::AnnotationKit::ShowPRCTessellationCompression | ( | bool & | out_state | ) | const |
bool HPS::Publish::AnnotationKit::ShowRendering | ( | Rendering::Mode & | out_mode | ) | const |
Shows the rendering mode setting.
out_mode | The rendering mode for the annotation. |
bool HPS::Publish::AnnotationKit::ShowSource | ( | Annotation::SourceType & | out_source_type, |
SprocketPath & | out_sprocket_paths, | ||
KeyPathArray & | out_key_paths | ||
) | const |
Shows the source setting.
out_source_type | Specifies which one of the previous arguments is valid |
out_sprocket_paths | The source SprocketPath for the annotation. Only valid if out_source_type is SprocketPath |
out_key_paths | The source KeyPath array for the annotation. Only valid if out_source_type is KeyPath |
bool HPS::Publish::AnnotationKit::ShowToolbarVisibility | ( | bool & | out_state | ) | const |
Shows the toolbar visibility setting.
out_state | Whether to display the toolbar when the annotation is activated. |
bool HPS::Publish::AnnotationKit::ShowTransparentBackground | ( | bool & | out_state | ) | const |
Shows the transparent background setting.
out_state | Whether the annotation has a transparent background. |
bool HPS::Publish::AnnotationKit::ShowU3DCompression | ( | unsigned char & | out_level | ) | const |
bool HPS::Publish::AnnotationKit::ShowU3DVersion | ( | U3D::Version & | out_version | ) | const |
AnnotationKit& HPS::Publish::AnnotationKit::UnsetActivation | ( | ) |
Removes the activation setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetArtwork | ( | ) |
Removes the artwork setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetBackgroundColor | ( | ) |
Removes the background color setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetBorderWidth | ( | ) |
Removes the border width setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetCarouselButtons | ( | ) |
Removes the carousel buttons setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetCarouselViews | ( | ) |
Removes the carousel views setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetDeactivation | ( | ) |
Removes the deactivation setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetEverything | ( | ) |
Removes all data on the annotation.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetFormat | ( | ) |
Removes the format setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetInteractivity | ( | ) |
Removes the interactivity setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetLighting | ( | ) |
Removes the lighting mode setting.a
AnnotationKit& HPS::Publish::AnnotationKit::UnsetModelTreeVisibility | ( | ) |
Removes the model tree visibility setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetName | ( | ) |
Removes the name setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetPosterImage | ( | ) |
Removes the poster image setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetPRCAttributeRemoval | ( | ) |
Removes the attribute removal for PRC data setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetPRCBRepCompression | ( | ) |
Removes the BRep compression level for PRC data setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetPRCBRepRemoval | ( | ) |
Removes the BRep removal for PRC data setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetPRCTessellationCompression | ( | ) |
Removes the tessellation compression for PRC data setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetRendering | ( | ) |
Removes the rendering mode setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetSource | ( | ) |
Removes the source setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetToolbarVisibility | ( | ) |
Removes the toolbar visibility setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetTransparentBackground | ( | ) |
Removes the transparent background setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetU3DCompression | ( | ) |
Removes the compression level for U3D data setting.
AnnotationKit& HPS::Publish::AnnotationKit::UnsetU3DVersion | ( | ) |
Removes the version for U3D data setting.