Deprecated Functions List

ComponentPath &HPS::ComponentPath::Append(ComponentArray const &in_components)

Appends the supplied key into this object. Same as operator+= function.

Deprecated:: This function exists for compatibility. Use ComponentPath::PushBack instead.

Parameters: in_components – The ComponentArray to be appended to this.
Returns: A reference to this object.

ComponentPath &HPS::ComponentPath::Append(ComponentPath const &in_path)

Appends the supplied key into this object. Same as operator+= function.

Deprecated:: This function exists for compatibility. Use ComponentPath::PushBack instead.

Parameters: in_path – The ComponentPath to be appended to this.
Returns: A reference to this object.

ComponentPath &HPS::ComponentPath::Append(Component const &in_component)

Appends the supplied Component into this object. Same as operator+= function.

Deprecated:: This function exists for compatibility. Use ComponentPath::PushBack instead.

Parameters: in_component – The Component to be appended to this.
Returns: A reference to this object.

CullingControl &HPS::CullingControl::SetBackFace(bool in_state)

Controls whether faces with normals that point away from the camera should be culled. This option can only be effective if a polygon handedness is defined.

Deprecated:: This function exists for compatibility. Use SetFace instead.

Parameters: in_state – Whether faces with normals that point away from the camera should be culled.
Returns: A reference to this object.

bool HPS::CullingControl::ShowBackFace(bool &out_state) const

Shows whether faces with normals that point away from the camera should be culled.

Deprecated:: This function exists for compatibility. Use ShowFace instead.

Parameters: out_state – Whether faces with normals that point away from the camera should be culled.
Returns: true if the setting is valid, false otherwise.

CullingControl &HPS::CullingControl::UnsetBackFace()

Removes the back face culling setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CullingKit::GetDefault().

Deprecated:: This function exists for compatibility. Use UnsetFace instead.

Returns: A reference to this object.

CullingKit &HPS::CullingKit::SetBackFace(bool in_state)

Controls whether faces with normals that point away from the camera should be culled.

Deprecated:: This function exists for compatibility. Use SetFace instead.

Parameters: in_state – Whether faces with normals that point away from the camera should be culled.
Returns: A reference to this object.

bool HPS::CullingKit::ShowBackFace(bool &out_state) const

Shows whether faces with normals that point away from the camera should be culled.

Deprecated:: This function exists for compatibility. Use ShowFace instead.

Parameters: out_state – Whether faces with normals that point away from the camera should be culled.
Returns: true if the setting is valid, false otherwise.

CullingKit &HPS::CullingKit::UnsetBackFace()

Removes the back face culling setting.

Deprecated:: This function exists for compatibility. Use SetFace instead.

Returns: A reference to this object.

ImportOptionsKit &HPS::Exchange::ImportOptionsKit::SetMultiProcessCount(unsigned int in_count)

Sets the number of processes to use when performing the import. This should be a value between 1 and the number of cores on your system.

Deprecated:: This function has been deprecated.

Note

Values greater than 1 can only be used for imports of certain formats, in particular, JT, SolidWorks, NX (Unigraphics), Creo (Pro/E), and CATIA V5 files.

Parameters: in_count – The number of processes to use when performing the import.
Returns: A reference to this ImportOptionsKit.

KeyPath &HPS::KeyPath::Append(KeyPath const &in_key_path)

Appends the supplied key into this object. Same as operator+= function.

Deprecated:: This function exists for compatibility. Use KeyPath::PushBack instead.

Parameters: in_key_path – The KeyPath to be appended to this.
Returns: A reference to this object.

KeyPath &HPS::KeyPath::Append(KeyArray const &in_key_array)

Appends the supplied key into this object. Same as operator+= function.

Deprecated:: This function exists for compatibility. Use KeyPath::PushBack instead.

Parameters: in_key_array – The KeyArray to be appended to this.
Returns: A reference to this object.

KeyPath &HPS::KeyPath::Append(Key const &in_key)

Appends the supplied Key into this object. Same as operator+= function.

Deprecated:: This function exists for compatibility. Use KeyPath::PushBack instead.

Parameters: in_key – The Key to be appended to this.
Returns: A reference to this object.

bool HPS::KeyPath::ShowNetBounding(BoundingKit &out_kit) const

Shows the net bounding along this key path without taking into account attributes set through highlights.

Deprecated:: This function exists for compatibility and ShowNetBounding(bool, BoundingKit &) should be preferred. This function will be removed in HPS 2021.

Returns: true if the setting is valid along this path, false otherwise.

bool HPS::MatrixKit::Empty() const

Indicates whether this object has any values set on it.

Deprecated:: This function exists for compatibility and will always return false.

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

MatrixKit &HPS::MatrixKit::UnsetEverything()

Sets this kit to an identity matrix.

Deprecated:: This function exists for compatibility and Reset should be preferred.

Returns: A reference to this kit.

OperatorControl &HPS::OperatorControl::Push(Operator *in_operator, Operator::Priority in_priority = Operator::Priority::Default)

Adds an operator to the top of the operator stack within its priority and assumes control of its memory. Existing operators in use are unmodified but operators on top get priority.

Deprecated:: It is recommended to use overloads which consume OperatorPtr as the object lifetime is simpler to reason about.

Parameters

in_operator – The operator to push to the top of the operator stack.
in_priority – The priority of the operator. All those with Low priority will be below all those with Normal priority which will, in turn, be below High priority operators.

Returns

A reference to this object.

OperatorControl &HPS::OperatorControl::Set(Operator *in_operator, Operator::Priority in_priority = Operator::Priority::Default)

Sets an operator as the only operator in use of the specified priority and assumes control of its memory. This replaces any existing operators in use and frees the memory associated with them.

Deprecated:: It is recommended to use overloads which consume OperatorPtr as the object lifetime is simpler to reason about.

Parameters

in_operator – An operator to use on this view.
in_priority – The priority of the operator. All those with Low priority will be below all those with Normal priority which will, in turn, be below High priority operators.

Returns

A reference to this object.

SelectionOptionsControl &HPS::SelectionOptionsControl::SetSorting(bool in_sorting)

Sets whether to sort selection results. This is only relevant if the related selection limit is greater than 0 (see SetRelatedLimit). Sorting works on an entity level. Subentity components like edges, vertices and faces are not sorted.

Deprecated:: This function exists for compatibility and SetSorting(Selection::Sorting) should be preferred in general usage.

See: Default value

Parameters: in_sorting – Whether to sort selection results. A value of true is equivalent to passing Selection::Sorting::Default to SetSorting(Selection::Sorting), and a value of false is equivalent to passing Selection::Sorting::Off to SetSorting(Selection::Sorting).
Returns: A reference to this SelectionOptionsControl.

SelectionOptionsKit &HPS::SelectionOptionsKit::SetSorting(bool in_sorting)

Sets whether to sort selection results. This is only relevant if the related selection limit is greater than 0 (see SetRelatedLimit). Sorting works on an entity level. Subentity components like edges, vertices and faces are not sorted.

Deprecated:: This function exists for compatibility and SetSorting(Selection::Sorting) should be preferred in general usage.

See: Default value

Parameters: in_sorting – Whether to sort selection results. A value of true is equivalent to passing Selection::Sorting::Default to SetSorting(Selection::Sorting), and a value of false is equivalent to passing Selection::Sorting::Off to SetSorting(Selection::Sorting).
Returns: A reference to this SelectionOptionsKit.

void HPS::View::SetOperator(Operator *in_operator)

Makes an operator active on this View. Assumes control of the memory of the operator.

Deprecated:: It is recommended to use overloads which consume OperatorPtr as the object lifetime is simpler to reason about.

Parameters: in_operator – the operator to be made active on this View.

VisualEffectsControl &HPS::VisualEffectsControl::SetAntiAliasing(bool in_state)

Manipulates the state of anti-aliasing(text and screen).

Deprecated:: This function exists for compatibility and SetTextAntiAliasing(bool in_state) should be preferred in general usage.

Parameters: in_state – Whether anti-aliasing(text and screen) should be used.
Returns: A reference to this object.

bool HPS::VisualEffectsControl::ShowAntiAliasing(bool &out_state) const

Shows the anti-aliasing setting.

Deprecated:: This function exists for compatibility and ShowTextAntiAliasing(bool & out_state) should be preferred in general usage.

Parameters: out_state – Whether anti-aliasing(text and screen) should be used.
Returns: true if the setting(text and screen) is valid, false otherwise.

VisualEffectsControl &HPS::VisualEffectsControl::UnsetAntiAliasing()

Removes any anti-alias setting(text and screen). If the control is attached to a WindowKey this function restores the default value of this setting as specified by VisualEffectsKit::GetDefault().

Deprecated:: This function exists for compatibility and UnsetTextAntiAliasing() should be preferred in general usage.

Returns: A reference to this object.

VisualEffectsKit &HPS::VisualEffectsKit::SetAntiAliasing(bool in_state)

Manipulates the state of anti-aliasing(text and screen).

Deprecated:: This function exists for compatibility and SetTextAntiAliasing(bool in_state) should be preferred in general usage.

Parameters: in_state – Whether anti-aliasing(text and screen) should be used.
Returns: A reference to this object.

bool HPS::VisualEffectsKit::ShowAntiAliasing(bool &out_state) const

Shows the anti-aliasing setting.

Deprecated:: This function exists for compatibility and ShowTextAntiAliasing(bool & out_state) should be preferred in general usage.

Parameters: out_state – Whether anti-aliasing(text and screen) should be used.
Returns: true if the setting(text and screen) is valid, false otherwise.

VisualEffectsKit &HPS::VisualEffectsKit::UnsetAntiAliasing()

Removes any anti-alias setting(text and screen).

Deprecated:: This function exists for compatibility and UnsetTextAntiAliasing() should be preferred in general usage.

Returns: A reference to this object.

DocumentKit &HPS::Publish::DocumentKit::AddDataTable(DataTableKit const &in_data_table)

Adds an data table to the document.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters: in_data_table – Data Table to be added into the document.
Returns: A reference to this DocumentKit.

DocumentKit &HPS::Publish::DocumentKit::AddDataTables(DataTableKitArray const in_data_table)

Adds data tables to the document.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters: in_data_table – Data Tables to be added into the document.
Returns: A reference to this DocumentKit.

DocumentKit &HPS::Publish::DocumentKit::UnsetDatatables()

Removes Data Table settings from the document.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Returns: A reference to this DocumentKit.

Warning

doxygenfunction: Unable to resolve function “HPS::Publish::DocumentKit::ShowDataTables” with arguments (DataTableKitArray&) in doxygen xml output for project “hps_cpp” from directory: /home/jenkins-sa/jenkins/workspace/hps/hps/documentation/build/html/../doxygen/hps_cpp/xml. Potential matches:

- bool ShowDataTables(DataTableKitArray &out_data_tables) const

PageKit &HPS::Publish::PageKit::SetTable(TableKit const &in_table, IntRectangle const &in_location)

Adds a table to the page. This will replace all tables (if any) on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_table – Table to add to the page.
in_location – Table location in points relative to upper left of the page. Only the left and top fields in the location will be used.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::AddTable(TableKit const &in_table, IntRectangle const &in_location)

Adds a table to the page. This will not replace any tables on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_table – Table to add to the page.
in_location – Table location in points relative to upper left of the page. Only the left and top fields in the location will be used.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::SetTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[])

Adds a list of tables to the page. This will replace all tables (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_count – Size of the following arrays.
in_tables – Tables to add to the page.
in_locations – Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::SetTables(TableKitArray const &in_tables, IntRectangleArray const &in_locations)

Adds a list of tables to the page. This will replace all tables (if any) on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_tables – Tables to add to the page.
in_locations – Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[])

Adds a list of tables to the page. This will not replace any tables on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_count – Size of the following arrays.
in_tables – Tables to add to the page.
in_locations – Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::AddTables(TableKitArray const &in_tables, IntRectangleArray const &in_locations)

Adds a list of tables to the page. This will not replace any tables on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_tables – Tables to add to the page.
in_locations – Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::SetSlideTable(SlideTableKit const &in_slide_table, IntRectangle const &in_location)

Adds a slide table to the page. This will replace all slide tables (if any) on the page. This corresponds to the value that will be passed to A3DPDFDefineSlideTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_slide_table – Slide table to add to the page.
in_location – Slide table location in points relative to upper left of the page. Only the left and top fields in the location will be used.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::AddSlideTable(SlideTableKit const &in_slide_table, IntRectangle const &in_location)

Adds a slide table to the page. This will not replace any slide tables on the page. This corresponds to the value that will be passed to A3DPDFDefineSlideTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_slide_table – Slide table to add to the page.
in_location – Slide table location in points relative to upper left of the page. Only the left and top fields in the location will be used.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::SetSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[])

Adds a list of slide tables to the page. This will replace all slide tables (if any) on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_count – Size of the following arrays.
in_slide_tables – Slide tables to add to the page.
in_locations – Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::SetSlideTables(SlideTableKitArray const &in_slide_tables, IntRectangleArray const &in_locations)

Adds a list of slide tables to the page. This will replace all slide tables (if any) on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_slide_tables – Slide tables to add to the page.
in_locations – Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[])

Adds a list of slide tables to the page. This will not replace any slide tables on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_count – Size of the following arrays.
in_slide_tables – Slide tables to add to the page.
in_locations – Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::AddSlideTables(SlideTableKitArray const &in_slide_tables, IntRectangleArray const &in_locations)

Adds a list of slide tables to the page. This will not replace any slide tables on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_slide_tables – Slide tables to add to the page.
in_locations – Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::UnsetTable(size_t in_index)

Removes the table at the given index from the page.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters: in_index – Index of the table to remove from the page.
Returns: A reference to this PageKit.

PageKit &HPS::Publish::PageKit::UnsetTables(size_t in_count, size_t const in_indices[])

Removes the tables at the given indices from the page.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_count – Size of the following array.
in_indices – Indices of the tables to remove from the page.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::UnsetTables(SizeTArray const &in_indices)

Removes the tables at the given indices from the page.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters: in_indices – Indices of the tables to remove from the page.
Returns: A reference to this PageKit.

PageKit &HPS::Publish::PageKit::UnsetTables()

Removes all tables from the page.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Returns: A reference to this PageKit.

PageKit &HPS::Publish::PageKit::UnsetSlideTable(size_t in_index)

Removes the slide table at the given index from the page.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters: in_index – Index of the slide table to remove from the page.
Returns: A reference to this PageKit.

PageKit &HPS::Publish::PageKit::UnsetSlideTables(size_t in_count, size_t const in_indices[])

Removes the slide tables at the given indices from the page.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_count – Size of the following array.
in_indices – Indices of the slide tables to remove from the page.

Returns

A reference to this PageKit.

PageKit &HPS::Publish::PageKit::UnsetSlideTables(SizeTArray const &in_indices)

Removes the slide tables at the given indices from the page.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters: in_indices – Indices of the slide tables to remove from the page.
Returns: A reference to this PageKit.

PageKit &HPS::Publish::PageKit::UnsetSlideTables()

Removes all slide tables from the page.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Returns: A reference to this PageKit.

bool HPS::Publish::PageKit::ShowTables(TableKitArray &out_tables, IntRectangleArray &out_locations) const

Shows the tables on the page.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

out_tables – Tables on the page.
out_locations – Table locations on the page.

Returns

true if tables were specified, false otherwise.

bool HPS::Publish::PageKit::ShowSlideTables(SlideTableKitArray &out_slide_tables, IntRectangleArray &out_locations) const

Shows the slide tables on the page.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

out_slide_tables – Slide tables on the page.
out_locations – Slide table locations on the page.

Returns

true if slide tables were specified, false otherwise.

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.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 *and will be dropped by the end of year 2024.

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

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 *and will be dropped by the end of year 2024.

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.

Warning

doxygenfunction: Cannot find function “HPS::Publish::TableKit” in doxygen xml output for project “hps_cpp” from directory: /home/jenkins-sa/jenkins/workspace/hps/hps/documentation/build/html/../doxygen/hps_cpp/xml

Warning

doxygenfunction: Cannot find function “HPS::Publish::SlideTableKit” in doxygen xml output for project “hps_cpp” from directory: /home/jenkins-sa/jenkins/workspace/hps/hps/documentation/build/html/../doxygen/hps_cpp/xml

Warning

doxygenfunction: Cannot find function “HPS::Publish::DataTableKit” in doxygen xml output for project “hps_cpp” from directory: /home/jenkins-sa/jenkins/workspace/hps/hps/documentation/build/html/../doxygen/hps_cpp/xml

PageControl &HPS::Publish::PageControl::AddTable(TableKit const &in_table, IntRectangle const &in_location)

Adds a table to the page. This will not replace any tables on the page. This corresponds to the value that will be passed to A3DPDFPageInsertTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_table – Table to add to the page.
in_location – Table location in points relative to upper left of the page. Only the left and top fields in the location will be used.

Returns

A reference to this PageControl.

PageControl &HPS::Publish::PageControl::AddTables(size_t in_count, TableKit const in_tables[], IntRectangle const in_locations[])

Adds a list of tables to the page. This will not replace any tables on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_count – Size of the following arrays.
in_tables – Tables to add to the page.
in_locations – Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.

Returns

A reference to this PageControl.

PageControl &HPS::Publish::PageControl::AddTables(TableKitArray const &in_tables, IntRectangleArray const &in_locations)

Adds a list of tables to the page. This will not replace any tables on the page. These correspond to values that will be passed to A3DPDFPageInsertTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_tables – Tables to add to the page.
in_locations – Table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.

Returns

A reference to this PageControl.

PageControl &HPS::Publish::PageControl::AddSlideTable(SlideTableKit const &in_slide_table, IntRectangle const &in_location)

Adds a slide table to the page. This will not replace any slide tables on the page. This corresponds to the value that will be passed to A3DPDFDefineSlideTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_slide_table – Slide table to add to the page.
in_location – Slide table location in points relative to upper left of the page. Only the left and top fields in the location will be used.

Returns

A reference to this PageControl.

PageControl &HPS::Publish::PageControl::AddSlideTables(size_t in_count, SlideTableKit const in_slide_tables[], IntRectangle const in_locations[])

Adds a list of slide tables to the page. This will not replace any slide tables on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_count – Size of the following arrays.
in_slide_tables – Slide tables to add to the page.
in_locations – Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.

Returns

A reference to this PageControl.

PageControl &HPS::Publish::PageControl::AddSlideTables(SlideTableKitArray const &in_slide_tables, IntRectangleArray const &in_locations)

Adds a list of slide tables to the page. This will not replace any slide tables on the page. These correspond to values that will be passed to A3DPDFDefineSlideTable.

Deprecated:: The TableToPDF Publish add-on used to create Tables on PDF page will be deprecated starting from 2024.4.0 and will be dropped by the end of year 2024.

Parameters

in_slide_tables – Slide tables to add to the page.
in_locations – Slide table locations in points relative to upper left of the page. Only the left and top fields in the locations will be used.

Returns

A reference to this PageControl.