#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::AnnotationKit:
HPS::SprocketKit HPS::Sprocket HPS::Object

Public Member Functions

 AnnotationKit ()
 
 AnnotationKit (AnnotationKit const &in_kit)
 
 AnnotationKit (AnnotationKit &&in_kit)
 
bool Empty () const
 
bool Equals (AnnotationKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (AnnotationKit const &in_kit) const
 
AnnotationKitoperator= (AnnotationKit const &in_kit)
 
AnnotationKitoperator= (AnnotationKit &&in_kit)
 
bool operator== (AnnotationKit const &in_kit) const
 
void Set (AnnotationKit const &in_kit)
 
AnnotationKitSetActivation (Activation::When in_when)
 
AnnotationKitSetArtwork (ArtworkKit const &in_artwork)
 
AnnotationKitSetBackgroundColor (RGBColor const &in_color)
 
AnnotationKitSetBorderWidth (int in_width)
 
AnnotationKitSetCarouselButtons (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)
 
AnnotationKitSetCarouselButtons (UTF8Array const &in_button_names, char const *in_previous_button_name, char const *in_next_button_name, size_t in_scroll_size)
 
AnnotationKitSetCarouselViews (size_t in_count, size_t const in_indices[], ImageKit const in_images[]=nullptr)
 
AnnotationKitSetCarouselViews (SizeTArray const &in_indices, ImageKitArray const &in_images=ImageKitArray())
 
AnnotationKitSetDeactivation (Deactivation::When in_when)
 
AnnotationKitSetFormat (Annotation::Format in_format)
 
AnnotationKitSetInteractivity (bool in_state)
 
AnnotationKitSetLighting (Lighting::Mode in_mode)
 
AnnotationKitSetModelTreeVisibility (bool in_state)
 
AnnotationKitSetName (char const *in_name)
 
AnnotationKitSetPartsList (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())
 
AnnotationKitSetPartsList (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())
 
AnnotationKitSetPMIList (IntRectangle const &in_location, HPS::Publish::ListBoxKit const &in_list)
 
AnnotationKitSetPMIListByField (char const *in_field)
 
AnnotationKitSetPosterImage (ImageKit const &in_image)
 
AnnotationKitSetPRCAttributeRemoval (bool in_state)
 
AnnotationKitSetPRCBRepCompression (PRC::BRepCompression in_level)
 
AnnotationKitSetPRCBRepRemoval (bool in_state)
 
AnnotationKitSetPRCTessellationCompression (bool in_state)
 
AnnotationKitSetRendering (Rendering::Mode in_mode)
 
AnnotationKitSetSource (CADModel const &in_cad_model)
 
AnnotationKitSetSource (KeyPathArray const &in_sources)
 
AnnotationKitSetSource (size_t in_count, KeyPath const in_sources[])
 
AnnotationKitSetSource (KeyPath const &in_source)
 
AnnotationKitSetSource (CADModel const &in_cad_model, KeyPathArray const &in_additional_sources)
 
AnnotationKitSetSource (CADModel const &in_cad_model, size_t in_count, KeyPath const in_additional_sources [])
 
AnnotationKitSetToolbarVisibility (bool in_state)
 
AnnotationKitSetTransparentBackground (bool in_state)
 
AnnotationKitSetU3DCompression (unsigned char in_level)
 
AnnotationKitSetU3DVersion (U3D::Version in_version)
 
AnnotationKitSetViewList (IntRectangle const &in_location, HPS::Publish::ListBoxKit const &in_list)
 
AnnotationKitSetViewListByField (char const *in_field)
 
void Show (AnnotationKit &out_kit) const
 
bool ShowActivation (Activation::When &out_when) const
 
bool ShowArtwork (ArtworkKit &out_artwork) const
 
bool ShowBackgroundColor (RGBColor &out_color) const
 
bool ShowBorderWidth (int &out_width) const
 
bool ShowCarouselButtons (UTF8Array &out_button_names, UTF8 &out_previous_button_name, UTF8 &out_next_button_name, size_t &out_scroll_size) const
 
bool ShowCarouselViews (SizeTArray &out_indices, ImageKitArray &out_images) const
 
bool ShowDeactivation (Deactivation::When &out_when) const
 
bool ShowFormat (Annotation::Format &out_format) const
 
bool ShowInteractivity (bool &out_state) const
 
bool ShowLighting (Lighting::Mode &out_mode) const
 
bool ShowModelTreeVisibility (bool &out_state) const
 
bool ShowName (UTF8 &out_name) const
 
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
 
bool ShowPMIList (IntRectangle &out_location, Publish::ListBoxKit &out_list) const
 
bool ShowPMIListField (UTF8 &out_field) const
 
bool ShowPosterImage (ImageKit &out_image) const
 
bool ShowPRCAttributeRemoval (bool &out_state) const
 
bool ShowPRCBRepCompression (PRC::BRepCompression &out_level) const
 
bool ShowPRCBRepRemoval (bool &out_state) const
 
bool ShowPRCTessellationCompression (bool &out_state) const
 
bool ShowRendering (Rendering::Mode &out_mode) const
 
bool ShowSource (Annotation::SourceType &out_source_type, CADModel &out_cad_model, KeyPathArray &out_key_paths) const
 
bool ShowToolbarVisibility (bool &out_state) const
 
bool ShowTransparentBackground (bool &out_state) const
 
bool ShowU3DCompression (unsigned char &out_level) const
 
bool ShowU3DVersion (U3D::Version &out_version) const
 
bool ShowViewList (IntRectangle &out_location, Publish::ListBoxKit &out_list) const
 
bool ShowViewListField (UTF8 &out_field) const
 
AnnotationKitUnsetActivation ()
 
AnnotationKitUnsetArtwork ()
 
AnnotationKitUnsetBackgroundColor ()
 
AnnotationKitUnsetBorderWidth ()
 
AnnotationKitUnsetCarouselButtons ()
 
AnnotationKitUnsetCarouselViews ()
 
AnnotationKitUnsetDeactivation ()
 
AnnotationKitUnsetEverything ()
 
AnnotationKitUnsetFormat ()
 
AnnotationKitUnsetInteractivity ()
 
AnnotationKitUnsetLighting ()
 
AnnotationKitUnsetModelTreeVisibility ()
 
AnnotationKitUnsetName ()
 
AnnotationKitUnsetPartsList ()
 
AnnotationKitUnsetPMIList ()
 
AnnotationKitUnsetPosterImage ()
 
AnnotationKitUnsetPRCAttributeRemoval ()
 
AnnotationKitUnsetPRCBRepCompression ()
 
AnnotationKitUnsetPRCBRepRemoval ()
 
AnnotationKitUnsetPRCTessellationCompression ()
 
AnnotationKitUnsetRendering ()
 
AnnotationKitUnsetSource ()
 
AnnotationKitUnsetToolbarVisibility ()
 
AnnotationKitUnsetTransparentBackground ()
 
AnnotationKitUnsetU3DCompression ()
 
AnnotationKitUnsetU3DVersion ()
 
AnnotationKitUnsetViewList ()
 
- Public Member Functions inherited from HPS::Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Member Functions

static AnnotationKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::PublishAnnotationKit
 
- Static Public Attributes inherited from HPS::SprocketKit
static const HPS::Type staticType = HPS::Type::SprocketKit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::SprocketKit
SprocketKitoperator= (SprocketKit &&in_that)
 
 SprocketKit (SprocketKit &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ AnnotationKit() [1/3]

HPS::Publish::AnnotationKit::AnnotationKit ( )

The default constructor creates an empty AnnotationKit object.

◆ AnnotationKit() [2/3]

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.

Parameters
in_kitThe source AnnotationKit to copy.

◆ AnnotationKit() [3/3]

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.

Parameters
in_kitAn rvalue reference to an AnnotationKit to take the underlying object from.

Member Function Documentation

◆ Empty()

bool HPS::Publish::AnnotationKit::Empty ( ) const
virtual

Indicates whether this AnnotationKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Publish::AnnotationKit::Equals ( AnnotationKit const &  in_kit) const

Check if the source AnnotationKit is equivalent to this AnnotationKit.

Parameters
in_kitThe source AnnotationKit to compare to this AnnotationKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static AnnotationKit HPS::Publish::AnnotationKit::GetDefault ( )
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.

Returns
A AnnotationKit with the default settings.

◆ ObjectType()

HPS::Type HPS::Publish::AnnotationKit::ObjectType ( ) const
inlinevirtual

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.

Reimplemented from HPS::SprocketKit.

◆ operator!=()

bool HPS::Publish::AnnotationKit::operator!= ( AnnotationKit const &  in_kit) const

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

Parameters
in_kitThe source AnnotationKit to compare to this AnnotationKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

AnnotationKit& HPS::Publish::AnnotationKit::operator= ( AnnotationKit const &  in_kit)

Copies the source AnnotationKit into this AnnotationKit.

Parameters
in_kitThe source AnnotationKit to copy.
Returns
A reference to this AnnotationKit.

◆ operator=() [2/2]

AnnotationKit& HPS::Publish::AnnotationKit::operator= ( AnnotationKit &&  in_kit)

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

Parameters
in_kitAn rvalue reference to an AnnotationKit to take the underlying object from.
Returns
A reference to this AnnotationKit.

◆ operator==()

bool HPS::Publish::AnnotationKit::operator== ( AnnotationKit const &  in_kit) const

Check if the source AnnotationKit is equivalent to this AnnotationKit.

Parameters
in_kitThe source AnnotationKit to compare to this AnnotationKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::Publish::AnnotationKit::Set ( AnnotationKit const &  in_kit)

Copies the source AnnotationKit into this AnnotationKit.

Parameters
in_kitThe source AnnotationKit to copy.

◆ SetActivation()

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.

Parameters
in_whenWhen the annotation is activated.
Returns
A reference to this AnnotationKit.

◆ SetArtwork()

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.

Parameters
in_artworkThe artwork for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetBackgroundColor()

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.

Parameters
in_colorThe background color for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetBorderWidth()

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.

Parameters
in_widthThe border width in points for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetCarouselButtons() [1/2]

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.

Parameters
in_countSize of the following array.
in_button_namesUTF8-encoded names for the view buttons in the carousel.
in_previous_button_nameUTF8-encoded name for the previous button.
in_next_button_nameUTF8-encoded name for the next button.
in_scroll_sizeNumber of buttons to scroll when the previous or next buttons are pressed.
Returns
A reference to this AnnotationKit.

◆ SetCarouselButtons() [2/2]

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.

Parameters
in_button_namesNames for the view buttons in the carousel.
in_previous_button_nameUTF8-encoded name for the previous button.
in_next_button_nameUTF8-encoded name for the next button.
in_scroll_sizeNumber of buttons to scroll when the previous or next buttons are pressed.
Returns
A reference to this AnnotationKit.

◆ SetCarouselViews() [1/2]

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.

Parameters
in_countSize of the following array.
in_indicesIndices of the views on the associated ArtworkKit to use for the view carousel.
in_imagesImages to use for the view carousel buttons. If unspecified, images will be generated from the views themselves.
Returns
A reference to this AnnotationKit.
See also
SetArtwork
ArtworkKit::SetViews

◆ SetCarouselViews() [2/2]

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.

Parameters
in_indicesIndices of the views on the associated ArtworkKit to use for the view carousel.
in_imagesImages to use for the view carousel buttons. If unspecified, images will be generated from the views themselves.
Returns
A reference to this AnnotationKit.
See also
SetArtwork
ArtworkKit::SetViews

◆ SetDeactivation()

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.

Parameters
in_whenWhen the annotation is deactivated.
Returns
A reference to this AnnotationKit.

◆ SetFormat()

AnnotationKit& HPS::Publish::AnnotationKit::SetFormat ( Annotation::Format  in_format)

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

Parameters
in_formatThe format of the 3D data for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetInteractivity()

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.

Parameters
in_stateWhether to enable interactivity on the annotation.
Returns
A reference to this AnnotationKit.

◆ SetLighting()

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.

Parameters
in_modeThe lighting mode for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetModelTreeVisibility()

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.

Parameters
in_stateWhether to display the model tree when the annotation is activated.
Returns
A reference to this AnnotationKit.

◆ SetName()

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.

Parameters
in_nameUTF8-encoded name for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetPartsList() [1/2]

AnnotationKit& HPS::Publish::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.

Parameters
in_rowsThe number of rows for the table housing the Parts List (including the header row)
in_locationThe 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_headersThe 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_columnsAn 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_styleThe text style used for the cells of the table. If not specified, default formatting is used.
in_header_text_styleThe text style used for the header of the table. If not specified, default formatting is used.
Returns
A reference to this AnnotationKit.
Warning
The TableToPDF Publish add-on must be installed in order to use this feature.

◆ SetPartsList() [2/2]

AnnotationKit& HPS::Publish::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.

Parameters
in_rowsThe number of rows for the table housing the Parts List (including the header row)
in_locationThe 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_headersThe 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_columnsAn 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_styleThe text style used for the cells of the table. If not specified, default formatting is used.
in_header_text_styleThe text style used for the header of the table. If not specified, default formatting is used.
Returns
A reference to this AnnotationKit.
Warning
The TableToPDF Publish add-on must be installed in order to use this feature.

◆ SetPMIList()

AnnotationKit& HPS::Publish::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_locationThe location of the PMI List, specified in points relative to bottom left of the page. All fields in the location will be used.
in_listThe ListBoxKit used to specify the attributes of the PMI List.
Returns
A reference to this AnnotationKit.

◆ SetPMIListByField()

AnnotationKit& HPS::Publish::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_fieldUTF8-encoded form field name for the PMI List.
Returns
A reference to this AnnotationKit.

◆ SetPosterImage()

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.

Parameters
in_imageThe poster image for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetPRCAttributeRemoval()

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.

Parameters
in_stateWhether to remove the attribute information in the PRC data for this annotation.
Returns
A reference to this AnnotationKit.

◆ SetPRCBRepCompression()

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.

Parameters
in_levelThe level of compression to apply to BRep data for a PRC annotation.
Returns
A reference to this AnnotationKit.

◆ SetPRCBRepRemoval()

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.

Parameters
in_stateWhether to remove BRep information in the PRC data for this annotation.
Returns
A reference to this AnnotationKit.

◆ SetPRCTessellationCompression()

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.

Parameters
in_stateWhether to compress tessellation for a PRC annotation.
Returns
A reference to this AnnotationKit.

◆ SetRendering()

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.

Parameters
in_modeThe rendering mode for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetSource() [1/6]

AnnotationKit& HPS::Publish::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_modelThe source CADModel for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetSource() [2/6]

AnnotationKit& HPS::Publish::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_sourcesThe source KeyPaths for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetSource() [3/6]

AnnotationKit& HPS::Publish::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_countThe number of elements in in_sources
in_sourcesThe source KeyPaths for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetSource() [4/6]

AnnotationKit& HPS::Publish::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_sourceThe source KeyPath for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetSource() [5/6]

AnnotationKit& HPS::Publish::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_modelThe source CADModel for the annotation.
in_additional_sourcesThe additional source KeyPaths for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetSource() [6/6]

AnnotationKit& HPS::Publish::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_modelThe source CADModel for the annotation.
in_countThe number of elements in in_additional_sources
in_additional_sourcesThe additional source KeyPaths for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetToolbarVisibility()

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.

Parameters
in_stateWhether to display the toolbar when the annotation is activated.
Returns
A reference to this AnnotationKit.

◆ SetTransparentBackground()

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.

Parameters
in_stateWhether the annotation background is transparent.
Returns
A reference to this AnnotationKit.

◆ SetU3DCompression()

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.

Parameters
in_levelThe 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.

◆ SetU3DVersion()

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.

Parameters
in_versionThe version of the data for a U3D annotation.
Returns
A reference to this AnnotationKit.

◆ SetViewList()

AnnotationKit& HPS::Publish::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_locationThe location of the View List, specified in points relative to bottom left of the page. All fields in the location will be used.
in_listThe ListBoxKit used to specify the attributes of the View List.
Returns
A reference to this AnnotationKit.

◆ SetViewListByField()

AnnotationKit& HPS::Publish::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_fieldUTF8-encoded form field name for the View List.
Returns
A reference to this AnnotationKit.

◆ Show()

void HPS::Publish::AnnotationKit::Show ( AnnotationKit out_kit) const

Copies this AnnotationKit into the given AnnotationKit.

Parameters
out_kitThe AnnotationKit to populate with the contents of this AnnotationKit.

◆ ShowActivation()

bool HPS::Publish::AnnotationKit::ShowActivation ( Activation::When out_when) const

Shows the activation setting.

Parameters
out_whenWhen the annotation is activated.
Returns
true if an activation setting was specified, false otherwise.

◆ ShowArtwork()

bool HPS::Publish::AnnotationKit::ShowArtwork ( ArtworkKit out_artwork) const

Shows the artwork setting.

Parameters
out_artworkThe artwork for the annotation.
Returns
true if an artwork was specified, false otherwise.

◆ ShowBackgroundColor()

bool HPS::Publish::AnnotationKit::ShowBackgroundColor ( RGBColor out_color) const

Shows the background color setting.

Parameters
out_colorThe background color for the annotation.
Returns
true if a background color was specified, false otherwise.

◆ ShowBorderWidth()

bool HPS::Publish::AnnotationKit::ShowBorderWidth ( int &  out_width) const

Shows the border width setting.

Parameters
out_widthThe border width of the annotation.
Returns
true if a border width was specified, false otherwise.

◆ ShowCarouselButtons()

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.

Parameters
out_button_namesNames for the view buttons in the carousel.
out_previous_button_nameName for the previous button.
out_next_button_nameName for the next button.
out_scroll_sizeNumbers of buttons scrolled when the previous or next buttons are pressed.
Returns
true if carousel buttons were specified, false otherwise.

◆ ShowCarouselViews()

bool HPS::Publish::AnnotationKit::ShowCarouselViews ( SizeTArray out_indices,
ImageKitArray &  out_images 
) const

Shows the carousel views setting.

Parameters
out_indicesIndices of the views on the associated ArtworkKit to use for the view carousel.
out_imagesImages 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.

◆ ShowDeactivation()

bool HPS::Publish::AnnotationKit::ShowDeactivation ( Deactivation::When out_when) const

Shows the deactivation setting.

Parameters
out_whenWhen the annotation is deactivated.
Returns
true if a deactivation setting was specified, false otherwise.

◆ ShowFormat()

bool HPS::Publish::AnnotationKit::ShowFormat ( Annotation::Format out_format) const

Shows the format setting.

Parameters
out_formatThe format of the 3D data for the annotation.
Returns
true if a format was specified, false otherwise.

◆ ShowInteractivity()

bool HPS::Publish::AnnotationKit::ShowInteractivity ( bool &  out_state) const

Shows the interactivity setting.

Parameters
out_stateWhether to enable interactivity on the annotation.
Returns
true if an interactivity setting was specified, false otherwise.

◆ ShowLighting()

bool HPS::Publish::AnnotationKit::ShowLighting ( Lighting::Mode out_mode) const

Shows the lighting mode setting.

Parameters
out_modeThe lighting mode for the annotation.
Returns
true if a lighting mode was specified, false otherwise.

◆ ShowModelTreeVisibility()

bool HPS::Publish::AnnotationKit::ShowModelTreeVisibility ( bool &  out_state) const

Shows the model tree visibility setting.

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

◆ ShowName()

bool HPS::Publish::AnnotationKit::ShowName ( UTF8 out_name) const

Shows the name setting.

Parameters
out_nameThe name for the annotation.
Returns
true if a name was specified, false otherwise.

◆ ShowPartsList()

bool HPS::Publish::AnnotationKit::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_rowsThe number of rows making up the Parts List table.
out_locationThe location of the Parts List table.
out_headersThe strings of the column headers. Empty if the table has no header.
out_columnsThe width of the three columns as percentages of the table width.
out_text_styleThe text styles used for the cells in the table.
out_header_text_styleThe text styles used for the header of the table.
Returns
true if a Parts List was specified, false otherwise.

◆ ShowPMIList()

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

Shows the PMI List setting.

Parameters
out_locationThe location of the PMI List table.
out_listThe options specified for the list box containing the PMI List
Returns
true if a PMI List was specified, false otherwise.

◆ ShowPMIListField()

bool HPS::Publish::AnnotationKit::ShowPMIListField ( UTF8 out_field) const

Shows the PMI List setting.

Parameters
out_fieldThe 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.

◆ ShowPosterImage()

bool HPS::Publish::AnnotationKit::ShowPosterImage ( ImageKit out_image) const

Shows the poster image setting.

Parameters
out_imageThe poster image for the annotation.
Returns
true if a poster image was specified, false otherwise.

◆ ShowPRCAttributeRemoval()

bool HPS::Publish::AnnotationKit::ShowPRCAttributeRemoval ( bool &  out_state) const

Shows the attribute removal for PRC data setting.

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

◆ ShowPRCBRepCompression()

bool HPS::Publish::AnnotationKit::ShowPRCBRepCompression ( PRC::BRepCompression out_level) const

Shows the BRep compression level for PRC data setting.

Parameters
out_levelThe 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.

◆ ShowPRCBRepRemoval()

bool HPS::Publish::AnnotationKit::ShowPRCBRepRemoval ( bool &  out_state) const

Shows the BRep removal for PRC data setting.

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

◆ ShowPRCTessellationCompression()

bool HPS::Publish::AnnotationKit::ShowPRCTessellationCompression ( bool &  out_state) const

Shows the tessellation compression for PRC data setting.

Parameters
out_stateWhether to compress tessellation for a PRC annotation.
Returns
true if a PRC tessellation compression setting was specified, false otherwise.

◆ ShowRendering()

bool HPS::Publish::AnnotationKit::ShowRendering ( Rendering::Mode out_mode) const

Shows the rendering mode setting.

Parameters
out_modeThe rendering mode for the annotation.
Returns
true if a rendering mode was specified, false otherwise.

◆ ShowSource()

bool HPS::Publish::AnnotationKit::ShowSource ( Annotation::SourceType out_source_type,
CADModel out_cad_model,
KeyPathArray out_key_paths 
) const

Shows the source setting.

Parameters
out_source_typeSpecifies which one of the previous arguments is valid
out_cad_modelThe source CADModel for the annotation. Only valid if out_source_type is CADModel or CADModelAndKeyPath
out_key_pathsThe 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.

◆ ShowToolbarVisibility()

bool HPS::Publish::AnnotationKit::ShowToolbarVisibility ( bool &  out_state) const

Shows the toolbar visibility setting.

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

◆ ShowTransparentBackground()

bool HPS::Publish::AnnotationKit::ShowTransparentBackground ( bool &  out_state) const

Shows the transparent background setting.

Parameters
out_stateWhether the annotation has a transparent background.
Returns
true if a transparent background setting specified, false otherwise.

◆ ShowU3DCompression()

bool HPS::Publish::AnnotationKit::ShowU3DCompression ( unsigned char &  out_level) const

Shows the compression level for U3D data for the annotation.

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

◆ ShowU3DVersion()

bool HPS::Publish::AnnotationKit::ShowU3DVersion ( U3D::Version out_version) const

Shows the version for U3D data setting.

Parameters
out_versionThe version of the data for a U3D annotation.
Returns
true if a U3D version setting was specified, false otherwise.

◆ ShowViewList()

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

Shows the View List setting.

Parameters
out_locationThe location of the View List table.
out_listThe options specified for the list box containing the View List
Returns
true if a View List was specified, false otherwise.

◆ ShowViewListField()

bool HPS::Publish::AnnotationKit::ShowViewListField ( UTF8 out_field) const

Shows the View List setting.

Parameters
out_fieldThe 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.

◆ UnsetActivation()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetActivation ( )

Removes the activation setting.

Returns
A reference to this AnnotationKit.

◆ UnsetArtwork()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetArtwork ( )

Removes the artwork setting.

Returns
A reference to this AnnotationKit.

◆ UnsetBackgroundColor()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetBackgroundColor ( )

Removes the background color setting.

Returns
A reference to this AnnotationKit.

◆ UnsetBorderWidth()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetBorderWidth ( )

Removes the border width setting.

Returns
A reference to this AnnotationKit.

◆ UnsetCarouselButtons()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetCarouselButtons ( )

Removes the carousel buttons setting.

Returns
A reference to this AnnotationKit.

◆ UnsetCarouselViews()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetCarouselViews ( )

Removes the carousel views setting.

Returns
A reference to this AnnotationKit.

◆ UnsetDeactivation()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetDeactivation ( )

Removes the deactivation setting.

Returns
A reference to this AnnotationKit.

◆ UnsetEverything()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetEverything ( )

Removes all data on the annotation.

Returns
A reference to this AnnotationKit.

◆ UnsetFormat()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetFormat ( )

Removes the format setting.

Returns
A reference to this AnnotationKit.

◆ UnsetInteractivity()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetInteractivity ( )

Removes the interactivity setting.

Returns
A reference to this AnnotationKit.

◆ UnsetLighting()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetLighting ( )

Removes the lighting mode setting.a

Returns
A reference to this AnnotationKit.

◆ UnsetModelTreeVisibility()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetModelTreeVisibility ( )

Removes the model tree visibility setting.

Returns
A reference to this AnnotationKit.

◆ UnsetName()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetName ( )

Removes the name setting.

Returns
A reference to this AnnotationKit.

◆ UnsetPartsList()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetPartsList ( )

Removes the Parts List setting.

Returns
A reference to this AnnotationKit

◆ UnsetPMIList()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetPMIList ( )

Removes the PMI List setting.

Returns
A reference to this AnnotationKit

◆ UnsetPosterImage()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetPosterImage ( )

Removes the poster image setting.

Returns
A reference to this AnnotationKit.

◆ UnsetPRCAttributeRemoval()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetPRCAttributeRemoval ( )

Removes the attribute removal for PRC data setting.

Returns
A reference to this AnnotationKit.

◆ UnsetPRCBRepCompression()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetPRCBRepCompression ( )

Removes the BRep compression level for PRC data setting.

Returns
A reference to this AnnotationKit.

◆ UnsetPRCBRepRemoval()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetPRCBRepRemoval ( )

Removes the BRep removal for PRC data setting.

Returns
A reference to this AnnotationKit.

◆ UnsetPRCTessellationCompression()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetPRCTessellationCompression ( )

Removes the tessellation compression for PRC data setting.

Returns
A reference to this AnnotationKit.

◆ UnsetRendering()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetRendering ( )

Removes the rendering mode setting.

Returns
A reference to this AnnotationKit.

◆ UnsetSource()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetSource ( )

Removes the source setting.

Returns
A reference to this AnnotationKit.

◆ UnsetToolbarVisibility()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetToolbarVisibility ( )

Removes the toolbar visibility setting.

Returns
A reference to this AnnotationKit.

◆ UnsetTransparentBackground()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetTransparentBackground ( )

Removes the transparent background setting.

Returns
A reference to this AnnotationKit.

◆ UnsetU3DCompression()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetU3DCompression ( )

Removes the compression level for U3D data setting.

Returns
A reference to this AnnotationKit.

◆ UnsetU3DVersion()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetU3DVersion ( )

Removes the version for U3D data setting.

Returns
A reference to this AnnotationKit.

◆ UnsetViewList()

AnnotationKit& HPS::Publish::AnnotationKit::UnsetViewList ( )

Removes the View List setting.

Returns
A reference to this AnnotationKit

The documentation for this class was generated from the following file: