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

Public Member Functions

 AnnotationKit ()
 
 AnnotationKit (HPS.Publish.AnnotationKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Publish.AnnotationKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Publish.AnnotationKit in_kit)
 
HPS.Publish.AnnotationKit SetActivation (HPS.Publish.Activation.When in_when)
 
HPS.Publish.AnnotationKit SetArtwork (HPS.Publish.ArtworkKit in_artwork)
 
HPS.Publish.AnnotationKit SetBackgroundColor (HPS.RGBColor in_color)
 
HPS.Publish.AnnotationKit SetBorderWidth (int in_width)
 
HPS.Publish.AnnotationKit SetCarouselButtons (string[] in_button_names, string in_previous_button_name, string in_next_button_name, ulong in_scroll_size)
 
HPS.Publish.AnnotationKit SetCarouselViews (ulong[] in_indices, HPS.Publish.ImageKit[] in_images)
 
HPS.Publish.AnnotationKit SetCarouselViews (ulong[] in_indices)
 
HPS.Publish.AnnotationKit SetDeactivation (HPS.Publish.Deactivation.When in_when)
 
HPS.Publish.AnnotationKit SetFormat (HPS.Publish.Annotation.Format in_format)
 
HPS.Publish.AnnotationKit SetInteractivity (bool in_state)
 
HPS.Publish.AnnotationKit SetLighting (HPS.Publish.Lighting.Mode in_mode)
 
HPS.Publish.AnnotationKit SetModelTreeVisibility (bool in_state)
 
HPS.Publish.AnnotationKit SetName (string in_name)
 
HPS.Publish.AnnotationKit SetPartsList (ulong in_rows, HPS.IntRectangle in_location, string[] in_headers, float[] in_columns, HPS.Publish.TextFieldKit in_text_style, HPS.Publish.TextFieldKit in_header_text_style)
 
HPS.Publish.AnnotationKit SetPartsList (ulong in_rows, HPS.IntRectangle in_location, string[] in_headers, float[] in_columns, HPS.Publish.TextFieldKit in_text_style)
 
HPS.Publish.AnnotationKit SetPartsList (ulong in_rows, HPS.IntRectangle in_location, string[] in_headers, float[] in_columns)
 
HPS.Publish.AnnotationKit SetPartsList (ulong in_rows, HPS.IntRectangle in_location, string[] in_headers)
 
HPS.Publish.AnnotationKit SetPartsList (ulong in_rows, HPS.IntRectangle in_location)
 
HPS.Publish.AnnotationKit SetPMIList (HPS.IntRectangle in_location, HPS.Publish.ListBoxKit in_list)
 
HPS.Publish.AnnotationKit SetPMIListByField (string in_field)
 
HPS.Publish.AnnotationKit SetPosterImage (HPS.Publish.ImageKit in_image)
 
HPS.Publish.AnnotationKit SetPRCAttributeRemoval (bool in_state)
 
HPS.Publish.AnnotationKit SetPRCBRepCompression (HPS.Publish.PRC.BRepCompression in_level)
 
HPS.Publish.AnnotationKit SetPRCBRepRemoval (bool in_state)
 
HPS.Publish.AnnotationKit SetPRCTessellationCompression (bool in_state)
 
HPS.Publish.AnnotationKit SetRendering (HPS.Publish.Rendering.Mode in_mode)
 
HPS.Publish.AnnotationKit SetSource (HPS.CADModel in_cad_model)
 
HPS.Publish.AnnotationKit SetSource (HPS.KeyPath[] in_sources)
 
HPS.Publish.AnnotationKit SetSource (HPS.KeyPath in_source)
 
HPS.Publish.AnnotationKit SetSource (HPS.CADModel in_cad_model, HPS.KeyPath[] in_additional_sources)
 
HPS.Publish.AnnotationKit SetToolbarVisibility (bool in_state)
 
HPS.Publish.AnnotationKit SetTransparentBackground (bool in_state)
 
HPS.Publish.AnnotationKit SetU3DCompression (byte in_level)
 
HPS.Publish.AnnotationKit SetU3DVersion (HPS.Publish.U3D.Version in_version)
 
HPS.Publish.AnnotationKit SetViewList (HPS.IntRectangle in_location, HPS.Publish.ListBoxKit in_list)
 
HPS.Publish.AnnotationKit SetViewListByField (string in_field)
 
void Show (out HPS.Publish.AnnotationKit out_kit)
 
bool ShowActivation (out HPS.Publish.Activation.When out_when)
 
bool ShowArtwork (out HPS.Publish.ArtworkKit out_artwork)
 
bool ShowBackgroundColor (out HPS.RGBColor out_color)
 
bool ShowBorderWidth (out int out_width)
 
bool ShowCarouselButtons (out string[] out_button_names, out string out_previous_button_name, out string out_next_button_name, out ulong out_scroll_size)
 
bool ShowCarouselViews (out ulong[] out_indices, out HPS.Publish.ImageKit[] out_images)
 
bool ShowDeactivation (out HPS.Publish.Deactivation.When out_when)
 
bool ShowFormat (out HPS.Publish.Annotation.Format out_format)
 
bool ShowInteractivity (out bool out_state)
 
bool ShowLighting (out HPS.Publish.Lighting.Mode out_mode)
 
bool ShowModelTreeVisibility (out bool out_state)
 
bool ShowName (out string out_name)
 
bool ShowPartsList (out ulong out_rows, out HPS.IntRectangle out_location, out string[] out_headers, out float[] out_columns, out HPS.Publish.TextFieldKit out_text_style, out HPS.Publish.TextFieldKit out_header_text_style)
 
bool ShowPMIList (out HPS.IntRectangle out_location, out HPS.Publish.ListBoxKit out_list)
 
bool ShowPMIListField (out string out_field)
 
bool ShowPosterImage (out HPS.Publish.ImageKit out_image)
 
bool ShowPRCAttributeRemoval (out bool out_state)
 
bool ShowPRCBRepCompression (out HPS.Publish.PRC.BRepCompression out_level)
 
bool ShowPRCBRepRemoval (out bool out_state)
 
bool ShowPRCTessellationCompression (out bool out_state)
 
bool ShowRendering (out HPS.Publish.Rendering.Mode out_mode)
 
bool ShowSource (out HPS.Publish.Annotation.SourceType out_source_type, out HPS.CADModel out_cad_model, out HPS.KeyPath[] out_key_paths)
 
bool ShowToolbarVisibility (out bool out_state)
 
bool ShowTransparentBackground (out bool out_state)
 
bool ShowU3DCompression (out byte out_level)
 
bool ShowU3DVersion (out HPS.Publish.U3D.Version out_version)
 
bool ShowViewList (out HPS.IntRectangle out_location, out HPS.Publish.ListBoxKit out_list)
 
bool ShowViewListField (out string out_field)
 
HPS.Publish.AnnotationKit UnsetActivation ()
 
HPS.Publish.AnnotationKit UnsetArtwork ()
 
HPS.Publish.AnnotationKit UnsetBackgroundColor ()
 
HPS.Publish.AnnotationKit UnsetBorderWidth ()
 
HPS.Publish.AnnotationKit UnsetCarouselButtons ()
 
HPS.Publish.AnnotationKit UnsetCarouselViews ()
 
HPS.Publish.AnnotationKit UnsetDeactivation ()
 
HPS.Publish.AnnotationKit UnsetEverything ()
 
HPS.Publish.AnnotationKit UnsetFormat ()
 
HPS.Publish.AnnotationKit UnsetInteractivity ()
 
HPS.Publish.AnnotationKit UnsetLighting ()
 
HPS.Publish.AnnotationKit UnsetModelTreeVisibility ()
 
HPS.Publish.AnnotationKit UnsetName ()
 
HPS.Publish.AnnotationKit UnsetPartsList ()
 
HPS.Publish.AnnotationKit UnsetPMIList ()
 
HPS.Publish.AnnotationKit UnsetPosterImage ()
 
HPS.Publish.AnnotationKit UnsetPRCAttributeRemoval ()
 
HPS.Publish.AnnotationKit UnsetPRCBRepCompression ()
 
HPS.Publish.AnnotationKit UnsetPRCBRepRemoval ()
 
HPS.Publish.AnnotationKit UnsetPRCTessellationCompression ()
 
HPS.Publish.AnnotationKit UnsetRendering ()
 
HPS.Publish.AnnotationKit UnsetSource ()
 
HPS.Publish.AnnotationKit UnsetToolbarVisibility ()
 
HPS.Publish.AnnotationKit UnsetTransparentBackground ()
 
HPS.Publish.AnnotationKit UnsetU3DCompression ()
 
HPS.Publish.AnnotationKit UnsetU3DVersion ()
 
HPS.Publish.AnnotationKit UnsetViewList ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Publish.AnnotationKit GetDefault ()
 
static bool operator!= (HPS.Publish.AnnotationKit a, HPS.Publish.AnnotationKit b)
 
static bool operator== (HPS.Publish.AnnotationKit a, HPS.Publish.AnnotationKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/2]

HPS.Publish.AnnotationKit.AnnotationKit ( )
inline

The default constructor creates an empty AnnotationKit object.

◆ AnnotationKit() [2/2]

HPS.Publish.AnnotationKit.AnnotationKit ( HPS.Publish.AnnotationKit  in_kit)
inline

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

Parameters
in_kitThe source AnnotationKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Publish.AnnotationKit.Empty ( )
inlinevirtual

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 ( HPS.Publish.AnnotationKit  in_kit)
inline

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

Creates a AnnotationKit which contains the default settings. The returned object will not necessarily have values for every setting, but it will have them where it is reasonable to have a default. These values will be used for export unless a setting is overridden by the AnnotationKit passed to File.Export.

Returns
A AnnotationKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.Publish.AnnotationKit.ObjectType ( )
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.

◆ Set()

void HPS.Publish.AnnotationKit.Set ( HPS.Publish.AnnotationKit  in_kit)
inline

Copies the source AnnotationKit into this AnnotationKit.

Parameters
in_kitThe source AnnotationKit to copy.

◆ SetActivation()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetActivation ( HPS.Publish.Activation.When  in_when)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetArtwork ( HPS.Publish.ArtworkKit  in_artwork)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetBackgroundColor ( HPS.RGBColor  in_color)
inline

Sets the background color for the annotation. Unused if there is a transparent background. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_sBackgroundColor.

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

◆ SetBorderWidth()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetBorderWidth ( int  in_width)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetCarouselButtons ( string []  in_button_names,
string  in_previous_button_name,
string  in_next_button_name,
ulong  in_scroll_size 
)
inline

Sets the carousel buttons for the annotation. This must be specified for a view carousel to be generated. This corresponds to the button names that will be passed to 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]

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetCarouselViews ( ulong []  in_indices,
HPS.Publish.ImageKit []  in_images 
)
inline

Sets the carousel views for the annotation. This can be optionally specified for a view carousel. This corresponds to the views and images that will be passed to 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

◆ SetCarouselViews() [2/2]

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetCarouselViews ( ulong []  in_indices)
inline

Sets the carousel views for the annotation. This can be optionally specified for a view carousel. This corresponds to the views and images that will be passed to A3DPDFDefineViewCarousel.

Parameters
in_indicesIndices of the views on the associated ArtworkKit to use for the view carousel.
Returns
A reference to this AnnotationKit.
See also
SetArtwork
ArtworkKit.SetViews

◆ SetDeactivation()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetDeactivation ( HPS.Publish.Deactivation.When  in_when)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetFormat ( HPS.Publish.Annotation.Format  in_format)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetInteractivity ( bool  in_state)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetLighting ( HPS.Publish.Lighting.Mode  in_mode)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetModelTreeVisibility ( bool  in_state)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetName ( string  in_name)
inline

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.

◆ SetPMIList()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetPMIList ( HPS.IntRectangle  in_location,
HPS.Publish.ListBoxKit  in_list 
)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetPMIListByField ( string  in_field)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetPosterImage ( HPS.Publish.ImageKit  in_image)
inline

Sets the poster image for the annotation. If this is not specified a poster image will be generated by Publish. This corresponds to the value that will be passed to A3DPDF3DAnnotData::m_pPosterImage.

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

◆ SetPRCAttributeRemoval()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetPRCAttributeRemoval ( bool  in_state)
inline

Sets whether to remove the attribute information in the PRC data for this annotation. This setting is only relevant if the format of the annotation is Annotation.Format.PRC. This corresponds to the value that will be passed to 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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetPRCBRepCompression ( HPS.Publish.PRC.BRepCompression  in_level)
inline

Sets the level of compression to apply to BRep data for a PRC annotation. This setting is only relevant if the format of the annotation is Annotation.Format.PRC. This corresponds to the values that will be passed to 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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetPRCBRepRemoval ( bool  in_state)
inline

Sets whether to remove the BRep information in the PRC data for this annotation. This setting is only relevant if the format of the annotation is Annotation.Format.PRC. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bRemoveBRep.

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

◆ SetPRCTessellationCompression()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetPRCTessellationCompression ( bool  in_state)
inline

Sets whether to compress tessellation for a PRC annotation. This setting is only relevant if the format of the annotation is Annotation.Format.PRC. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bCompressTessellation.

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

◆ SetRendering()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetRendering ( HPS.Publish.Rendering.Mode  in_mode)
inline

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/4]

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetSource ( HPS.CADModel  in_cad_model)
inline

Sets the source for the annotation to Annotation.SourceType.CADModel.

This is the CADModel which contains the 3D data to be exported into the annotation

Parameters
in_cad_modelThe source CADModel for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetSource() [2/4]

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetSource ( HPS.KeyPath []  in_sources)
inline

Sets the source for the annotation to Annotation.SourceType.KeyPaths.

These are the KeyPaths that will be used to locate the 3D data for the annotation.

Parameters
in_sourcesThe source KeyPaths for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetSource() [3/4]

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetSource ( HPS.KeyPath  in_source)
inline

Sets the source for the annotation to Annotation.SourceType.KeyPaths. The Key Path that will be used to locate the 3D data for the annotation.

Parameters
in_sourceThe source KeyPath for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetSource() [4/4]

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetSource ( HPS.CADModel  in_cad_model,
HPS.KeyPath []  in_additional_sources 
)
inline

Sets the source for the annotation to Annotation.SourceType.CADModelAndKeyPaths. These are the CADModel which will be used to export 3D data to the annotation, and the KeyPaths which will be added to the model

Parameters
in_cad_modelThe source CADModel for the annotation.
in_additional_sourcesThe additional source KeyPaths for the annotation.
Returns
A reference to this AnnotationKit.

◆ SetToolbarVisibility()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetToolbarVisibility ( bool  in_state)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetTransparentBackground ( bool  in_state)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetU3DCompression ( byte  in_level)
inline

Sets the level of compression to apply to tessellations for a U3D annotation. If no compression level is set, no compression will be applied. This setting is only relevant if the format of the annotation is Annotation.Format.U3D. This corresponds to the value that will be passed to 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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetU3DVersion ( HPS.Publish.U3D.Version  in_version)
inline

Sets the version of the data for a U3D annotation. This setting is only relevant if the format of the annotation is Annotation.Format.U3D. This corresponds to the value that will be passed to A3DRWParamsExportU3DData::m_eU3DVersion.

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

◆ SetViewList()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetViewList ( HPS.IntRectangle  in_location,
HPS.Publish.ListBoxKit  in_list 
)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.SetViewListByField ( string  in_field)
inline

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 ( out HPS.Publish.AnnotationKit  out_kit)
inline

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 ( out HPS.Publish.Activation.When  out_when)
inline

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 ( out HPS.Publish.ArtworkKit  out_artwork)
inline

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 ( out HPS.RGBColor  out_color)
inline

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 ( out int  out_width)
inline

Shows the border width setting.

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

◆ ShowCarouselViews()

bool HPS.Publish.AnnotationKit.ShowCarouselViews ( out ulong []  out_indices,
out HPS.Publish.ImageKit []  out_images 
)
inline

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 ( out HPS.Publish.Deactivation.When  out_when)
inline

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 ( out HPS.Publish.Annotation.Format  out_format)
inline

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 ( out bool  out_state)
inline

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 ( out HPS.Publish.Lighting.Mode  out_mode)
inline

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 ( out bool  out_state)
inline

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 ( out string  out_name)
inline

Shows the name setting.

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

◆ ShowPMIList()

bool HPS.Publish.AnnotationKit.ShowPMIList ( out HPS.IntRectangle  out_location,
out HPS.Publish.ListBoxKit  out_list 
)
inline

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 ( out string  out_field)
inline

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 ( out HPS.Publish.ImageKit  out_image)
inline

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 ( out bool  out_state)
inline

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 ( out HPS.Publish.PRC.BRepCompression  out_level)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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 ( out HPS.Publish.Rendering.Mode  out_mode)
inline

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 ( out HPS.Publish.Annotation.SourceType  out_source_type,
out HPS.CADModel  out_cad_model,
out HPS.KeyPath []  out_key_paths 
)
inline

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 ( out bool  out_state)
inline

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 ( out bool  out_state)
inline

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 ( out byte  out_level)
inline

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 ( out HPS.Publish.U3D.Version  out_version)
inline

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 ( out HPS.IntRectangle  out_location,
out HPS.Publish.ListBoxKit  out_list 
)
inline

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 ( out string  out_field)
inline

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()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetActivation ( )
inline

Removes the activation setting.

Returns
A reference to this AnnotationKit.

◆ UnsetArtwork()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetArtwork ( )
inline

Removes the artwork setting.

Returns
A reference to this AnnotationKit.

◆ UnsetBackgroundColor()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetBackgroundColor ( )
inline

Removes the background color setting.

Returns
A reference to this AnnotationKit.

◆ UnsetBorderWidth()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetBorderWidth ( )
inline

Removes the border width setting.

Returns
A reference to this AnnotationKit.

◆ UnsetCarouselButtons()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetCarouselButtons ( )
inline

Removes the carousel buttons setting.

Returns
A reference to this AnnotationKit.

◆ UnsetCarouselViews()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetCarouselViews ( )
inline

Removes the carousel views setting.

Returns
A reference to this AnnotationKit.

◆ UnsetDeactivation()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetDeactivation ( )
inline

Removes the deactivation setting.

Returns
A reference to this AnnotationKit.

◆ UnsetEverything()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetEverything ( )
inline

Removes all data on the annotation.

Returns
A reference to this AnnotationKit.

◆ UnsetFormat()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetFormat ( )
inline

Removes the format setting.

Returns
A reference to this AnnotationKit.

◆ UnsetInteractivity()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetInteractivity ( )
inline

Removes the interactivity setting.

Returns
A reference to this AnnotationKit.

◆ UnsetLighting()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetLighting ( )
inline

Removes the lighting mode setting.a

Returns
A reference to this AnnotationKit.

◆ UnsetModelTreeVisibility()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetModelTreeVisibility ( )
inline

Removes the model tree visibility setting.

Returns
A reference to this AnnotationKit.

◆ UnsetName()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetName ( )
inline

Removes the name setting.

Returns
A reference to this AnnotationKit.

◆ UnsetPartsList()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetPartsList ( )
inline

Removes the Parts List setting.

Returns
A reference to this AnnotationKit

◆ UnsetPMIList()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetPMIList ( )
inline

Removes the PMI List setting.

Returns
A reference to this AnnotationKit

◆ UnsetPosterImage()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetPosterImage ( )
inline

Removes the poster image setting.

Returns
A reference to this AnnotationKit.

◆ UnsetPRCAttributeRemoval()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetPRCAttributeRemoval ( )
inline

Removes the attribute removal for PRC data setting.

Returns
A reference to this AnnotationKit.

◆ UnsetPRCBRepCompression()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetPRCBRepCompression ( )
inline

Removes the BRep compression level for PRC data setting.

Returns
A reference to this AnnotationKit.

◆ UnsetPRCBRepRemoval()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetPRCBRepRemoval ( )
inline

Removes the BRep removal for PRC data setting.

Returns
A reference to this AnnotationKit.

◆ UnsetPRCTessellationCompression()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetPRCTessellationCompression ( )
inline

Removes the tessellation compression for PRC data setting.

Returns
A reference to this AnnotationKit.

◆ UnsetRendering()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetRendering ( )
inline

Removes the rendering mode setting.

Returns
A reference to this AnnotationKit.

◆ UnsetSource()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetSource ( )
inline

Removes the source setting.

Returns
A reference to this AnnotationKit.

◆ UnsetToolbarVisibility()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetToolbarVisibility ( )
inline

Removes the toolbar visibility setting.

Returns
A reference to this AnnotationKit.

◆ UnsetTransparentBackground()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetTransparentBackground ( )
inline

Removes the transparent background setting.

Returns
A reference to this AnnotationKit.

◆ UnsetU3DCompression()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetU3DCompression ( )
inline

Removes the compression level for U3D data setting.

Returns
A reference to this AnnotationKit.

◆ UnsetU3DVersion()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetU3DVersion ( )
inline

Removes the version for U3D data setting.

Returns
A reference to this AnnotationKit.

◆ UnsetViewList()

HPS.Publish.AnnotationKit HPS.Publish.AnnotationKit.UnsetViewList ( )
inline

Removes the View List setting.

Returns
A reference to this AnnotationKit

The documentation for this class was generated from the following file:
  • internals/hps_sprk_publish/source/cs/HPS.Publish.cs