HPS::Publish::AnnotationKit

class HPS::Publish::AnnotationKit : public HPS::SprocketKit

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.

Public Functions

AnnotationKit(): The default constructor creates an empty AnnotationKit object.

AnnotationKit(AnnotationKit &&in_kit)

The move constructor creates an AnnotationKit by transferring the underlying object of the rvalue reference to this AnnotationKit.

Parameters: in_kit – An rvalue reference to an AnnotationKit to take the underlying object from.

AnnotationKit(AnnotationKit const &in_kit)

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

Parameters: in_kit – The source AnnotationKit to copy.

virtual bool Empty() const

Indicates whether this AnnotationKit has any values set on it.

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

bool Equals(AnnotationKit const &in_kit) const

Check if the source AnnotationKit is equivalent to this AnnotationKit.

Parameters: in_kit – The source AnnotationKit to compare to this AnnotationKit.
Returns: true if the objects are equivalent, false otherwise.

inline virtual HPS::Type ObjectType() const

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

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

bool operator!=(AnnotationKit const &in_kit) const

Check if the source AnnotationKit is not equivalent to this AnnotationKit.

Parameters: in_kit – The source AnnotationKit to compare to this AnnotationKit.
Returns: true if the objects are not equivalent, false otherwise.

AnnotationKit &operator=(AnnotationKit &&in_kit)

The move assignment operator transfers the underlying object of the rvalue reference to this AnnotationKit.

Parameters: in_kit – An rvalue reference to an AnnotationKit to take the underlying object from.
Returns: A reference to this AnnotationKit.

AnnotationKit &operator=(AnnotationKit const &in_kit)

Copies the source AnnotationKit into this AnnotationKit.

Parameters: in_kit – The source AnnotationKit to copy.
Returns: A reference to this AnnotationKit.

bool operator==(AnnotationKit const &in_kit) const

Check if the source AnnotationKit is equivalent to this AnnotationKit.

Parameters: in_kit – The source AnnotationKit to compare to this AnnotationKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(AnnotationKit const &in_kit)

Copies the source AnnotationKit into this AnnotationKit.

Parameters: in_kit – The source AnnotationKit to copy.

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.

Parameters: in_when – When the annotation is activated.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_artwork – The artwork for the annotation.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_color – The background color for the annotation.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_width – The border width in points for the annotation.
Returns: A reference to this AnnotationKit.

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.

Parameters

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.

Returns

A reference to this AnnotationKit.

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.

Parameters

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.

Returns

A reference to this AnnotationKit.

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.

See: SetArtwork
See: ArtworkKit::SetViews

Parameters

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.

Returns

A reference to this AnnotationKit.

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.

See: SetArtwork
See: ArtworkKit::SetViews

Parameters

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.

Returns

A reference to this AnnotationKit.

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.

Parameters: in_when – When the annotation is deactivated.
Returns: A reference to this AnnotationKit.

AnnotationKit &SetFormat(Annotation::Format in_format)

Sets the format of the 3D data for the annotation.

Parameters: in_format – The format of the 3D data for the annotation.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_state – Whether to enable interactivity on the annotation.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_mode – The lighting mode for the annotation.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_state – Whether to display the model tree when the annotation is activated.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_name – UTF8-encoded name for the annotation.
Returns: A reference to this AnnotationKit.

AnnotationKit &SetPartsList(size_t in_rows, IntRectangle const &in_location, char const *in_headers[3], float const in_columns[3], TextFieldKit const &in_text_style = TextFieldKit(), TextFieldKit const &in_header_text_style = TextFieldKit())

Creates a Parts List contained in a scrollable table. The table will have three columns, listing part number, part name and quantity. The Parts List can only be calculated if the Annotation source is a CADModel, and the annotation format is PRC.

Warning

The TableToPDF Publish add-on must be installed in order to use this feature.

Parameters

in_rows – The number of rows for the table housing the Parts List (including the header row)
in_location – The location of the table housing the Parts List, specified in points relative to bottom left of the page. All fields in the location will be used.
in_headers – The strings displayed in the column headers. The first column lists the part numbers. The second column lists the part name. The third column lists the part quantity. Leaving it unspecified will result in a table with no headers.
in_columns – An array of three percentages, specifying the width of each of the table’s columns as a percentage of the table width. The total of the values contained in in_columns should total 1.0. For example, if the columns should take up 10%, 80% and 10% of the table width respectively, in_column will contain 0.1, 0.8, 0.1 Leaving in_columns unspecified will use the default column widths.
in_text_style – The text style used for the cells of the table. If not specified, default formatting is used.
in_header_text_style – The text style used for the header of the table. If not specified, default formatting is used.

Returns

A reference to this AnnotationKit.

AnnotationKit &SetPartsList(size_t in_rows, IntRectangle const &in_location, UTF8Array const &in_headers = UTF8Array(), FloatArray const &in_columns = FloatArray(), TextFieldKit const &in_text_style = TextFieldKit(), TextFieldKit const &in_header_text_style = TextFieldKit())

Creates a Parts List contained in a scrollable table. The table will have three columns, listing part number, part name and quantity. The Parts List can only be calculated if the Annotation source is a CADModel, and the annotation format is PRC.

Warning

The TableToPDF Publish add-on must be installed in order to use this feature.

Parameters

in_rows – The number of rows for the table housing the Parts List (including the header row)
in_location – The location of the table housing the Parts List, specified in points relative to bottom left of the page. All fields in the location will be used.
in_headers – The strings displayed in the column headers. The size of this array should be 3. The first column lists the part numbers. The second column lists the part name. The third column lists the part quantity. Leaving it unspecified will result in a table with no headers.
in_columns – An array of three percentages, specifying the width of each of the table’s columns as a percentage of the table width. The total of the values contained in in_columns should total 1.0. For example, if the columns should take up 10%, 80% and 10% of the table width respectively, in_column will contain 0.1, 0.8, 0.1 Leaving in_columns unspecified will use the default column widths.
in_text_style – The text style used for the cells of the table. If not specified, default formatting is used.
in_header_text_style – The text style used for the header of the table. If not specified, default formatting is used.

Returns

A reference to this AnnotationKit.

AnnotationKit &SetPMIList(IntRectangle const &in_location, HPS::Publish::ListBoxKit const &in_list)

Creates a PMI List Box which contains a list of the PMI contained in the source file. Clicking on the entries of the list will highlight the associated PMI in the 3D annotation. The PMI List can only be calculated if the Annotation source is a CADModel, and the annotation format is PRC. If a View List or a View Carousel are also set on this annotation kit, the PMI List will only show the PMIs which are visible in the View you currently have selected in the PDF.

Parameters

in_location – The location of the PMI List, specified in points relative to bottom left of the page. All fields in the location will be used.
in_list – The ListBoxKit used to specify the attributes of the PMI List.

Returns

A reference to this AnnotationKit.

AnnotationKit &SetPMIListByField(char const *in_field)

Creates a PMI List Box which contains a list of the PMI contained in the source file. Clicking on the entries of the list will highlight the associated PMI in the 3D annotation. The PMI List can only be calculated if the Annotation source is a CADModel, and the annotation format is PRC. If a View List or a View Carousel are also set on this annotation kit, the PMI List will only show the PMIs which are visible in the View you currently have selected in the PDF.

Parameters: in_field – UTF8-encoded form field name for the PMI List.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_image – The poster image for the annotation.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_state – Whether to remove the attribute information in the PRC data for this annotation.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_level – The level of compression to apply to BRep data for a PRC annotation.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_state – Whether to remove BRep information in the PRC data for this annotation.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_state – Whether to compress tessellation for a PRC annotation.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_mode – The rendering mode for the annotation.
Returns: A reference to this AnnotationKit.

AnnotationKit &SetSource(CADModel const &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

Parameters: in_cad_model – The source CADModel for the annotation.
Returns: A reference to this AnnotationKit.

AnnotationKit &SetSource(CADModel const &in_cad_model, KeyPathArray const &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

Parameters

in_cad_model – The source CADModel for the annotation.
in_additional_sources – The additional source KeyPaths for the annotation.

Returns

A reference to this AnnotationKit.

AnnotationKit &SetSource(CADModel const &in_cad_model, size_t in_count, KeyPath const 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

Parameters

in_cad_model – The source CADModel for the annotation.
in_count – The number of elements in in_additional_sources
in_additional_sources – The additional source KeyPaths for the annotation.

Returns

A reference to this AnnotationKit.

AnnotationKit &SetSource(KeyPath const &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.

Parameters: in_source – The source KeyPath for the annotation.
Returns: A reference to this AnnotationKit.

AnnotationKit &SetSource(KeyPathArray const &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.

Parameters: in_sources – The source KeyPaths for the annotation.
Returns: A reference to this AnnotationKit.

AnnotationKit &SetSource(size_t in_count, KeyPath const 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.

Parameters

in_count – The number of elements in in_sources
in_sources – The source KeyPaths for the annotation.

Returns

A reference to this AnnotationKit.

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.

Parameters: in_state – Whether to display the toolbar when the annotation is activated.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_state – Whether the annotation background is transparent.
Returns: A reference to this AnnotationKit.

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.

Parameters: in_level – The level of compression to apply to tessellations for a U3D annotation. This value should be in the range [0, 100].
Returns: A reference to this AnnotationKit.

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.

Parameters: in_version – The version of the data for a U3D annotation.
Returns: A reference to this AnnotationKit.

AnnotationKit &SetViewList(IntRectangle const &in_location, HPS::Publish::ListBoxKit const &in_list)

Creates a View List Box which contains a list of the Views contained in the source file. Clicking on the entries of the list will activate the associated View. The View List can only be calculated if the Annotation source is a CADModel, and the annotation format is PRC.

Parameters

in_location – The location of the View List, specified in points relative to bottom left of the page. All fields in the location will be used.
in_list – The ListBoxKit used to specify the attributes of the View List.

Returns

A reference to this AnnotationKit.

AnnotationKit &SetViewListByField(char const *in_field)

Creates a View List Box which contains a list of the Views contained in the source file. Clicking on the entries of the list will activate the associated View. The View List can only be calculated if the Annotation source is a CADModel, and the annotation format is PRC.

Parameters: in_field – UTF8-encoded form field name for the View List.
Returns: A reference to this AnnotationKit.

void Show(AnnotationKit &out_kit) const

Copies this AnnotationKit into the given AnnotationKit.

Parameters: out_kit – The AnnotationKit to populate with the contents of this AnnotationKit.

bool ShowActivation(Activation::When &out_when) const

Shows the activation setting.

Parameters: out_when – When the annotation is activated.
Returns: true if an activation setting was specified, false otherwise.

bool ShowArtwork(ArtworkKit &out_artwork) const

Shows the artwork setting.

Parameters: out_artwork – The artwork for the annotation.
Returns: true if an artwork was specified, false otherwise.

bool ShowBackgroundColor(RGBColor &out_color) const

Shows the background color setting.

Parameters: out_color – The background color for the annotation.
Returns: true if a background color was specified, false otherwise.

bool ShowBorderWidth(int &out_width) const

Shows the border width setting.

Parameters: out_width – The border width of the annotation.
Returns: true if a border width was specified, false otherwise.

bool 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.

Parameters

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.

Returns

true if carousel buttons were specified, false otherwise.

bool ShowCarouselViews(SizeTArray &out_indices, ImageKitArray &out_images) const

Shows the carousel views setting.

Parameters

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.

Returns

true if carousel views were specified, false otherwise.

bool ShowDeactivation(Deactivation::When &out_when) const

Shows the deactivation setting.

Parameters: out_when – When the annotation is deactivated.
Returns: true if a deactivation setting was specified, false otherwise.

bool ShowFormat(Annotation::Format &out_format) const

Shows the format setting.

Parameters: out_format – The format of the 3D data for the annotation.
Returns: true if a format was specified, false otherwise.

bool ShowInteractivity(bool &out_state) const

Shows the interactivity setting.

Parameters: out_state – Whether to enable interactivity on the annotation.
Returns: true if an interactivity setting was specified, false otherwise.

bool ShowLighting(Lighting::Mode &out_mode) const

Shows the lighting mode setting.

Parameters: out_mode – The lighting mode for the annotation.
Returns: true if a lighting mode was specified, false otherwise.

bool ShowModelTreeVisibility(bool &out_state) const

Shows the model tree visibility setting.

Parameters: out_state – Whether to display the model tree when the annotation is activated.
Returns: true if a model tree visibility was specified, false otherwise.

bool ShowName(UTF8 &out_name) const

Shows the name setting.

Parameters: out_name – The name for the annotation.
Returns: true if a name was specified, false otherwise.

bool ShowPartsList(size_t &out_rows, IntRectangle &out_location, UTF8Array &out_headers, FloatArray &out_columns, TextFieldKit &out_text_style, TextFieldKit &out_header_text_style) const

Shows the Parts List setting.

Parameters

out_rows – The number of rows making up the Parts List table.
out_location – The location of the Parts List table.
out_headers – The strings of the column headers. Empty if the table has no header.
out_columns – The width of the three columns as percentages of the table width.
out_text_style – The text styles used for the cells in the table.
out_header_text_style – The text styles used for the header of the table.

Returns

true if a Parts List was specified, false otherwise.

bool ShowPMIList(IntRectangle &out_location, Publish::ListBoxKit &out_list) const

Shows the PMI List setting.

Parameters

out_location – The location of the PMI List table.
out_list – The options specified for the list box containing the PMI List

Returns

true if a PMI List was specified, false otherwise.

bool ShowPMIListField(UTF8 &out_field) const

Shows the PMI List setting.

Parameters: out_field – The list box form field name on the page which will be used for the PMI List.
Returns: true if a PMI List was specified by field, false otherwise.

bool ShowPosterImage(ImageKit &out_image) const

Shows the poster image setting.

Parameters: out_image – The poster image for the annotation.
Returns: true if a poster image was specified, false otherwise.

bool ShowPRCAttributeRemoval(bool &out_state) const

Shows the attribute removal for PRC data setting.

Parameters: out_state – Whether to remove attribute information in the PRC data for this annotation.
Returns: true if an attribute removal setting was specified, false otherwise.

bool ShowPRCBRepCompression(PRC::BRepCompression &out_level) const

Shows the BRep compression level for PRC data setting.

Parameters: out_level – The level of compression to apply to BRep data for a PRC annotation.
Returns: true if a PRC BRep compression level setting was specified, false otherwise.

bool ShowPRCBRepRemoval(bool &out_state) const

Shows the BRep removal for PRC data setting.

Parameters: out_state – Whether to remove BRep information in the PRC data for this annotation.
Returns: true if a BRep removal setting was specified, false otherwise.

bool ShowPRCTessellationCompression(bool &out_state) const

Shows the tessellation compression for PRC data setting.

Parameters: out_state – Whether to compress tessellation for a PRC annotation.
Returns: true if a PRC tessellation compression setting was specified, false otherwise.

bool ShowRendering(Rendering::Mode &out_mode) const

Shows the rendering mode setting.

Parameters: out_mode – The rendering mode for the annotation.
Returns: true if a rendering mode was specified, false otherwise.

bool ShowSource(Annotation::SourceType &out_source_type, CADModel &out_cad_model, KeyPathArray &out_key_paths) const

Shows the source setting.

Parameters

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

Returns

true if a source was specified, false otherwise.

bool ShowToolbarVisibility(bool &out_state) const

Shows the toolbar visibility setting.

Parameters: out_state – Whether to display the toolbar when the annotation is activated.
Returns: true if a toolbar visibility was specified, false otherwise.

bool ShowTransparentBackground(bool &out_state) const

Shows the transparent background setting.

Parameters: out_state – Whether the annotation has a transparent background.
Returns: true if a transparent background setting specified, false otherwise.

bool ShowU3DCompression(unsigned char &out_level) const

Shows the compression level for U3D data for the annotation.

Parameters: out_level – The level of compression to apply to tessellations for a U3D annotation.
Returns: true if a U3D compression setting was specified, false otherwise.

bool ShowU3DVersion(U3D::Version &out_version) const

Shows the version for U3D data setting.

Parameters: out_version – The version of the data for a U3D annotation.
Returns: true if a U3D version setting was specified, false otherwise.

bool ShowViewList(IntRectangle &out_location, Publish::ListBoxKit &out_list) const

Shows the View List setting.

Parameters

out_location – The location of the View List table.
out_list – The options specified for the list box containing the View List

Returns

true if a View List was specified, false otherwise.

bool ShowViewListField(UTF8 &out_field) const

Shows the View List setting.

Parameters: out_field – The list box form field name on the page which will be used for the View List.
Returns: true if a View List was specified by field, false otherwise.

AnnotationKit &UnsetActivation()

Removes the activation setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetArtwork()

Removes the artwork setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetBackgroundColor()

Removes the background color setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetBorderWidth()

Removes the border width setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetCarouselButtons()

Removes the carousel buttons setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetCarouselViews()

Removes the carousel views setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetDeactivation()

Removes the deactivation setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetEverything()

Removes all data on the annotation.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetFormat()

Removes the format setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetInteractivity()

Removes the interactivity setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetLighting()

Removes the lighting mode setting.a

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetModelTreeVisibility()

Removes the model tree visibility setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetName()

Removes the name setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetPartsList()

Removes the Parts List setting.

Returns: A reference to this AnnotationKit

AnnotationKit &UnsetPMIList()

Removes the PMI List setting.

Returns: A reference to this AnnotationKit

AnnotationKit &UnsetPosterImage()

Removes the poster image setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetPRCAttributeRemoval()

Removes the attribute removal for PRC data setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetPRCBRepCompression()

Removes the BRep compression level for PRC data setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetPRCBRepRemoval()

Removes the BRep removal for PRC data setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetPRCTessellationCompression()

Removes the tessellation compression for PRC data setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetRendering()

Removes the rendering mode setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetSource()

Removes the source setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetToolbarVisibility()

Removes the toolbar visibility setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetTransparentBackground()

Removes the transparent background setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetU3DCompression()

Removes the compression level for U3D data setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetU3DVersion()

Removes the version for U3D data setting.

Returns: A reference to this AnnotationKit.

AnnotationKit &UnsetViewList()

Removes the View List setting.

Returns: A reference to this AnnotationKit

virtual ~AnnotationKit()

Public Static Functions

static 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.

Returns: A AnnotationKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::PublishAnnotationKit