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.
HPS::Exchange::ImportOptionsKit::SetMultiProcessCount(unsigned int in_count)
-
ImportOptionsKit &
HPS::Exchange::ImportOptionsKit::
deprecated_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 is deprecated and will be removed in version 2026.1.0.
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.
HPS::Exchange::ImportOptionsKit::UnsetMultiProcessCount()
-
ImportOptionsKit &
HPS::Exchange::ImportOptionsKit::
deprecated_UnsetMultiProcessCount
() - Deprecated:
Removes the multi-process count setting.
- Deprecated:
This is deprecated and will be removed in version 2026.1.0.
Returns: A reference to this ImportOptionsKit.
HPS::Exchange::ImportOptionsKit::ShowMultiProcessCount(unsigned int& out_count)
-
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 also
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 also
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.
HPS::Publish::DocumentKit::SetPasswords(char const* in_user_password, char const* in_owner_password)
-
DocumentKit &
HPS::Publish::DocumentKit::
deprecated_SetPasswords
(char const *in_user_password, char const *in_owner_password) Sets the passwords for this document. This corresponds to the value that will be passed to A3DPDFDocumentSetPassword.
- Deprecated:
This is deprecated and will be removed in version 2026.1.0. Use SetPasswordSecurity instead.
Parameters: - in_user_password – UTF8-encoded password string required when opening, modifying or printing the document. If an empty string is specified, no password will be required.
- in_owner_password – UTF8-encoded password string required when changing security features of document. If an empty string is specified, no password will be required.
Returns: A reference to this DocumentKit.
HPS::Publish::DocumentKit::SetPermissions(size_t in_count, Permission::Type const in_permissions[])
-
DocumentKit &
HPS::Publish::DocumentKit::
deprecated_SetPermissions
(size_t in_count, Permission::Type const in_permissions[]) Sets document permissions. This correspond to the values that will be passed to A3DPDFDocumentSetDocumentPermissions.
- Deprecated:
This is deprecated and will be removed in version 2026.1.0. Use SetPasswordSecurity instead.
Parameters: - in_count – Size of the following array.
- in_permissions – The permissions to be set on the document.
Returns: A reference to this DocumentKit.
HPS::Publish::DocumentKit::SetPermissions(PermissionTypeArray const& in_permissions)
-
DocumentKit &
HPS::Publish::DocumentKit::
deprecated_SetPermissions
(PermissionTypeArray const &in_permissions) Sets document permissions. This correspond to the values that will be passed to A3DPDFDocumentSetDocumentPermissions.
- Deprecated:
This is deprecated and will be removed in version 2026.1.0. Use SetPasswordSecurity instead.
Parameters: in_permissions – The permissions to be set on the document. Returns: A reference to this DocumentKit.
HPS::Publish::DocumentKit::UnsetPasswords()
-
DocumentKit &
HPS::Publish::DocumentKit::
deprecated_UnsetPasswords
() Removes the document passwords.
- Deprecated:
This is deprecated and will be removed in version 2026.1.0. Use UnsetPasswordSecurity instead.
Returns: A reference to this DocumentKit.
HPS::Publish::DocumentKit::UnsetPermissions()
-
DocumentKit &
HPS::Publish::DocumentKit::
deprecated_UnsetPermissions
() Removes permission settings from the document.
- Deprecated:
This is deprecated and will be removed in version 2026.1.0. Use UnsetPasswordSecurity instead.
Returns: A reference to this DocumentKit.
HPS::Publish::DocumentKit::ShowPasswords(UTF8& out_user_password, UTF8& out_owner_password) const
-
bool
HPS::Publish::DocumentKit::
deprecated_ShowPasswords
(UTF8 &out_user_password, UTF8 &out_owner_password) const Shows the document passwords.
- Deprecated:
This is deprecated and will be removed in version 2026.1.0. Use ShowPasswordSecurity instead.
Parameters: - out_user_password – User password of the document.
- out_owner_password – Owner password of the document.
Returns: true if passwords were specified, false otherwise.
HPS::Publish::DocumentKit::ShowPermissions(PermissionTypeArray& out_permissions) const
-
bool
HPS::Publish::DocumentKit::
deprecated_ShowPermissions
(PermissionTypeArray &out_permissions) const Shows permissions on the document
- Deprecated:
This is deprecated and will be removed in version 2026.1.0. Use ShowPasswordSecurity instead.
Parameters: out_permissions – Permissions on the document. Returns: true if permissions were specified, false otherwise.
HPS::Publish::DocumentKey::SetPasswords(char const* in_user_password, char const* in_owner_password)
-
DocumentKey &
HPS::Publish::DocumentKey::
deprecated_SetPasswords
(char const *in_user_password, char const *in_owner_password) Sets the passwords for this document. This corresponds to the value that will be passed to A3DPDFDocumentSetPassword.
- Deprecated:
This is deprecated and will be removed in version 2026.1.0. Use SetPasswordSecurity instead.
Parameters: - in_user_password – UTF8-encoded password string required when opening, modifying or printing the document. If an empty string is specified, no password will be required.
- in_owner_password – UTF8-encoded password string required when changing security features of document. If an empty string is specified, no password will be required.
Returns: A reference to this DocumentKey.
HPS::Publish::DocumentKey::SetPermissions(size_t in_count, Permission::Type const in_permissions[])
-
DocumentKey &
HPS::Publish::DocumentKey::
deprecated_SetPermissions
(size_t in_count, Permission::Type const in_permissions[]) Sets document permissions. This correspond to the values that will be passed to A3DPDFDocumentSetDocumentPermissions.
- Deprecated:
This is deprecated and will be removed in version 2026.1.0. Use SetPasswordSecurity instead.
Parameters: - in_count – Size of the following array.
- in_permissions – The permissions to be set on the document.
Returns: A reference to this DocumentKey.
HPS::Publish::DocumentKey::SetPermissions(PermissionTypeArray const& in_permissions)
-
DocumentKey &
HPS::Publish::DocumentKey::
deprecated_SetPermissions
(PermissionTypeArray const &in_permissions) Sets document permissions. This correspond to the values that will be passed to A3DPDFDocumentSetDocumentPermissions.
- Deprecated:
This is deprecated and will be removed in version 2026.1.0. Use SetPasswordSecurity instead.
Parameters: in_permissions – The permissions to be set on the document. Returns: A reference to this DocumentKey.
Deprecated Enum Value List
HPS::Exchange::STEP::Format::AP242