RoughnessEntity

Functions

RoughnessEntity
RoughnessEntity
~RoughnessEntity
void Set
RoughnessEntity const & operator=
Type GetType
Roughness::Obtention::Type GetObtentionType
void SetObtentionType
Roughness::Applicability::Type GetApplicabilityType
void SetApplicabilityType
Roughness::Mode::Type GetModeType
void SetModeType
unsigned int GetFieldCount
void GetFields
void SetFields

Detailed Description

class RoughnessEntity : public PMI::Entity

This class represents a roughness feature.

Public Functions

RoughnessEntity(HC_KEY segment_key = (-1L))

Constructs a RoughnessEntity object. It requires specifying the segment key where the RoughnessEntity will insert associated geometry.

RoughnessEntity(RoughnessEntity const &that)
virtual ~RoughnessEntity()
void Set(RoughnessEntity const &that)
RoughnessEntity const &operator=(RoughnessEntity const &that)
inline virtual Type GetType() const
Returns:the PMI::Type for this entity. Overridden by subclasses.
Roughness::Obtention::Type GetObtentionType() const
Returns:the obtention type of this RoughnessEntity
void SetObtentionType(Roughness::Obtention::Type const in_obtention_type)

Sets the obtention type of this RoughnessEntity. This will replace an existing obtention type.

Roughness::Applicability::Type GetApplicabilityType() const
Returns:the applicability type of this RoughnessEntity
void SetApplicabilityType(Roughness::Applicability::Type const in_applicability_type)

Sets the applicability type of this RoughnessEntity. This will replace an existing applicability type.

Roughness::Mode::Type GetModeType() const
Returns:the mode type of this RoughnessEntity
void SetModeType(Roughness::Mode::Type const in_mode_type)

Sets the mode type of this RoughnessEntity. This will replace an existing mode type.

unsigned int GetFieldCount() const
Returns:the number of fields for this RoughnessEntity
void GetFields(unsigned int &out_count, String out_fields[], TextAttributes out_text_attributes[]) const

Gets the fields for this RoughnessEntity.

Parameters:
  • out_count – the number of fields for this RoughnessEntity. Returned to the user.
  • out_fields – the array of fields for this RoughnessEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.
  • out_text_attributes – the array of TextAttributes for the fields for this RoughnessEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.
void SetFields(unsigned int in_count, String const in_fields[], TextAttributes const in_text_attributes[])

Sets the fields for this RoughnessEntity. These will replace any existing fields.

Parameters: