defines IGESSegmentedViewsVisible, Type <402> Form <19> in package IGESDraw More...

#include <IGESDraw_SegmentedViewsVisible.hxx>

Inheritance diagram for IGESDraw_SegmentedViewsVisible:

[legend]

Public Member Functions
	IGESDraw_SegmentedViewsVisible ()

void	Init (const occ::handle< NCollection_HArray1< occ::handle< IGESData_ViewKindEntity > > > &allViews, const occ::handle< NCollection_HArray1< double > > &allBreakpointParameters, const occ::handle< NCollection_HArray1< int > > &allDisplayFlags, const occ::handle< NCollection_HArray1< int > > &allColorValues, const occ::handle< NCollection_HArray1< occ::handle< IGESGraph_Color > > > &allColorDefinitions, const occ::handle< NCollection_HArray1< int > > &allLineFontValues, const occ::handle< NCollection_HArray1< occ::handle< IGESData_LineFontEntity > > > &allLineFontDefinitions, const occ::handle< NCollection_HArray1< int > > &allLineWeights)
	This method is used to set the fields of the class SegmentedViewsVisible.

bool	IsSingle () const override
	Returns False (for a complex view)

int	NbViews () const override
	Returns the count of Views referenced by <me> (inherited)

int	NbSegmentBlocks () const
	returns the number of view/segment blocks in <me> Similar to NbViews but has a more general significance

occ::handle< IGESData_ViewKindEntity >	ViewItem (const int ViewIndex) const override
	returns the View entity indicated by ViewIndex raises an exception if ViewIndex <= 0 or ViewIndex > NbSegmentBlocks()

double	BreakpointParameter (const int BreakpointIndex) const
	returns the parameter of the breakpoint indicated by BreakpointIndex raises an exception if BreakpointIndex <= 0 or BreakpointIndex > NbSegmentBlocks().

int	DisplayFlag (const int FlagIndex) const
	returns the Display flag indicated by FlagIndex raises an exception if FlagIndex <= 0 or FlagIndex > NbSegmentBlocks().

bool	IsColorDefinition (const int ColorIndex) const
	returns True if the ColorIndex'th value of the "theColorDefinitions" field of <me> is a pointer raises an exception if ColorIndex <= 0 or ColorIndex > NbSegmentBlocks().

int	ColorValue (const int ColorIndex) const
	returns the Color value indicated by ColorIndex raises an exception if ColorIndex <= 0 or ColorIndex > NbSegmentBlocks().

occ::handle< IGESGraph_Color >	ColorDefinition (const int ColorIndex) const
	returns the Color definition entity indicated by ColorIndex raises an exception if ColorIndex <= 0 or ColorIndex > NbSegmentBlocks().

bool	IsFontDefinition (const int FontIndex) const
	returns True if the FontIndex'th value of the "theLineFontDefinitions" field of <me> is a pointer raises an exception if FontIndex <= 0 or FontIndex > NbSegmentBlocks().

int	LineFontValue (const int FontIndex) const
	returns the LineFont value indicated by FontIndex raises an exception if FontIndex <= 0 or FontIndex > NbSegmentBlocks().

occ::handle< IGESData_LineFontEntity >	LineFontDefinition (const int FontIndex) const
	returns the LineFont definition entity indicated by FontIndex raises an exception if FontIndex <= 0 or FontIndex > NbSegmentBlocks().

int	LineWeightItem (const int WeightIndex) const
	returns the LineWeight value indicated by WeightIndex raises an exception if WeightIndex <= 0 or WeightIndex > NbSegmentBlocks().

Public Member Functions inherited from IGESData_IGESEntity
IGESData_IGESType	IGESType () const
	gives IGES typing info (includes "Type" and "Form" data)

int	TypeNumber () const
	gives IGES Type Number (often coupled with Form Number)

int	FormNumber () const
	Returns the form number for that type of an IGES entity. The default form number is 0.

occ::handle< IGESData_IGESEntity >	DirFieldEntity (const int fieldnum) const
	Returns the Entity which has been recorded for a given Field Number, i.e. without any cast. Maps with: 3 : Structure 4 : LineFont 5 : LevelList 6 : View 7 : Transf(ormation Matrix) 8 : LabelDisplay 13 : Color. Other values give a null handle It can then be of any kind, while specific items have a Type.

bool	HasStructure () const
	returns True if an IGESEntity is defined with a Structure (it is normally reserved for certain classes, such as Macros)

occ::handle< IGESData_IGESEntity >	Structure () const
	Returns Structure (used by some types of IGES Entities only) Returns a Null Handle if Structure is not defined.

virtual IGESData_DefType	DefLineFont () const
	Returns the definition status of LineFont.

int	RankLineFont () const
	Returns LineFont definition as an Integer (if defined as Rank) If LineFont is defined as an Entity, returns a negative value.

occ::handle< IGESData_LineFontEntity >	LineFont () const
	Returns LineFont as an Entity (if defined as Reference) Returns a Null Handle if DefLineFont is not "DefReference".

virtual IGESData_DefList	DefLevel () const
	Returns the definition status of Level.

int	Level () const
	Returns the level the entity belongs to. Returns -1 if the entity belongs to more than one level.

occ::handle< IGESData_LevelListEntity >	LevelList () const
	Returns LevelList if Level is defined as a list. Returns a null handle if DefLevel is not DefSeveral.

virtual IGESData_DefList	DefView () const
	Returns the definition status of the view. This can be: none, one or several.

occ::handle< IGESData_ViewKindEntity >	View () const
	Returns the view of this IGES entity. This view can be a single view or a list of views. Warning A null handle is returned if the view is not defined.

occ::handle< IGESData_ViewKindEntity >	SingleView () const
	Returns the view as a single view if it was defined as such and not as a list of views. Warning A null handle is returned if DefView does not have the value DefOne.

occ::handle< IGESData_ViewKindEntity >	ViewList () const
	Returns the view of this IGES entity as a list. Warning A null handle is returned if the definition status does not have the value DefSeveral.

bool	HasTransf () const
	Returns True if a Transformation Matrix is defined.

occ::handle< IGESData_TransfEntity >	Transf () const
	Returns the Transformation Matrix (under IGES definition) Returns a Null Handle if there is none for a more complete use, see Location & CompoundLocation.

bool	HasLabelDisplay () const
	Returns True if a LabelDisplay mode is defined for this entity.

occ::handle< IGESData_LabelDisplayEntity >	LabelDisplay () const
	Returns the Label Display Associativity Entity if there is one. Returns a null handle if there is none.

int	BlankStatus () const
	gives Blank Status (0 visible, 1 blanked)

int	SubordinateStatus () const
	gives Subordinate Switch (0-1-2-3)

int	UseFlag () const
	gives Entity's Use Flag (0 to 5)

int	HierarchyStatus () const
	gives Hierarchy status (0-1-2)

int	LineWeightNumber () const
	Returns the LineWeight Number (0 not defined), see also LineWeight.

double	LineWeight () const
	Returns the true Line Weight, computed from LineWeightNumber and Global Parameter in the Model by call to SetLineWeight.

virtual IGESData_DefType	DefColor () const
	Returns the definition status of Color.

int	RankColor () const
	Returns the color definition as an integer value if the color was defined as a rank. Warning A negative value is returned if the color was defined as an entity.

occ::handle< IGESData_ColorEntity >	Color () const
	Returns the IGES entity which describes the color of the entity. Returns a null handle if this entity was defined as an integer.

bool	CResValues (char res1, char res2) const
	returns "reserved" alphanumeric values res1 and res2 res1 and res2 have to be reserved as Character[9 at least] (remark : their content is changed) returned values are ended by null character in 9th returned Boolean is False if res1 and res2 are blank, true else

bool	HasShortLabel () const
	Returns true if a short label is defined. A short label is a non-blank 8-character string.

occ::handle< TCollection_HAsciiString >	ShortLabel () const
	Returns the label value for this IGES entity as a string. Warning If the label is blank, this string is null.

virtual bool	HasSubScriptNumber () const
	Returns true if a subscript number is defined. A subscript number is an integer used to identify a label.

int	SubScriptNumber () const
	Returns the integer subscript number used to identify this IGES entity. Warning 0 is returned if no subscript number is defined for this IGES entity.

void	InitDirFieldEntity (const int fieldnum, const occ::handle< IGESData_IGESEntity > &ent)
	Initializes a directory field as an Entity of any kind See DirFieldEntity for more details.

void	InitTransf (const occ::handle< IGESData_TransfEntity > &ent)
	Initializes Transf, or erases it if <ent> is given Null.

void	InitView (const occ::handle< IGESData_ViewKindEntity > &ent)
	Initializes View, or erases it if <ent> is given Null.

void	InitLineFont (const occ::handle< IGESData_LineFontEntity > &ent, const int rank=0)
	Initializes LineFont : if <ent> is not Null, it gives LineFont, else <rank> gives or erases (if zero) RankLineFont.

void	InitLevel (const occ::handle< IGESData_LevelListEntity > &ent, const int val=0)
	Initializes Level : if <ent> is not Null, it gives LevelList, else <val> gives or erases (if zero) unique Level.

void	InitColor (const occ::handle< IGESData_ColorEntity > &ent, const int rank=0)
	Initializes Color data : if <ent> is not Null, it gives Color, else <rank> gives or erases (if zero) RankColor.

void	InitStatus (const int blank, const int subordinate, const int useflag, const int hierarchy)
	Initializes the Status of Directory Part.

void	SetLabel (const occ::handle< TCollection_HAsciiString > &label, const int sub=-1)
	Sets a new Label to an IGES Entity If _{is given, it sets value of SubScriptNumber else, SubScriptNumber is erased.}

void	InitMisc (const occ::handle< IGESData_IGESEntity > &str, const occ::handle< IGESData_LabelDisplayEntity > &lab, const int weightnum)
	Initializes various data (those not yet seen above), or erases them if they are given as Null (Zero for <weightnum>) : <str> for Structure, <lab> for LabelDisplay, and <weightnum> for WeightNumber.

bool	HasOneParent () const
	Returns True if an entity has one and only one parent, defined by a SingleParentEntity Type Associativity (explicit sharing). Thus, implicit sharing remains defined at model level (see class ToolLocation)

occ::handle< IGESData_IGESEntity >	UniqueParent () const
	Returns the Unique Parent (in the sense given by HasOneParent) Error if there is none or several.

gp_GTrsf	Location () const
	Returns Location given by Transf in Directory Part (see above) It must be considered for local definition : if the Entity is set in a "Parent", that one can add its one Location, but this is not taken in account here : see CompoundLocation for that. If no Transf is defined, returns Identity If Transf is itself compound, gives the final result.

gp_GTrsf	VectorLocation () const
	Returns Location considered for Vectors, i.e. without its Translation Part. As Location, it gives local definition.

gp_GTrsf	CompoundLocation () const
	Returns Location by taking in account a Parent which has its own Location : that one will be combined to that of <me> The Parent is considered only if HasOneParent is True, else it is ignored and CompoundLocation = Location.

bool	HasName () const
	says if a Name is defined, as Short Label or as Name Property (Property is looked first, else ShortLabel is considered)

occ::handle< TCollection_HAsciiString >	NameValue () const
	returns Name value as a String (Property Name or ShortLabel) if SubNumber is defined, it is concatenated after ShortLabel as follows label(number). Ignored with a Property Name

bool	ArePresentAssociativities () const
	Returns True if the Entity is defined with an Associativity list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list.

int	NbAssociativities () const
	gives number of recorded associativities (0 no list defined)

Interface_EntityIterator	Associativities () const
	Returns the Associativity List under the form of an EntityIterator.

int	NbTypedAssociativities (const occ::handle< Standard_Type > &atype) const
	gives how many Associativities have a given type

occ::handle< IGESData_IGESEntity >	TypedAssociativity (const occ::handle< Standard_Type > &atype) const
	returns the Associativity of a given Type (if only one exists) Error if none or more than one

void	Associate (const occ::handle< IGESData_IGESEntity > &ent) const
	Sets "me" in the Associativity list of another Entity.

void	Dissociate (const occ::handle< IGESData_IGESEntity > &ent) const
	Resets "me" from the Associativity list of another Entity.

bool	ArePresentProperties () const
	Returns True if the Entity is defined with a Property list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list.

int	NbProperties () const
	Gives number of recorded properties (0 no list defined)

Interface_EntityIterator	Properties () const
	Returns Property List under the form of an EntityIterator.

int	NbTypedProperties (const occ::handle< Standard_Type > &atype) const
	gives how many Properties have a given type

occ::handle< IGESData_IGESEntity >	TypedProperty (const occ::handle< Standard_Type > &atype, const int anum=0) const
	returns the Property of a given Type Error if none or more than one

void	AddProperty (const occ::handle< IGESData_IGESEntity > &ent)
	Adds a Property in the list.

void	RemoveProperty (const occ::handle< IGESData_IGESEntity > &ent)
	Removes a Property from the list.

void	SetLineWeight (const double defw, const double maxw, const int gradw)
	computes and sets "true" line weight according IGES rules from global data MaxLineWeight (maxv) and LineWeightGrad (gradw), or sets it to defw (Default) if LineWeightNumber is null

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Protected Member Functions inherited from IGESData_IGESEntity
	IGESData_IGESEntity ()
	prepares lists of optional data, set values to defaults

void	InitTypeAndForm (const int typenum, const int formnum)
	Initializes Type and Form Numbers to new values. Reserved for special uses.

void	LoadAssociativities (const Interface_EntityList &list)
	Loads a complete, already loaded, List of Asociativities (used during Read or Copy Operations)

void	LoadProperties (const Interface_EntityList &list)
	Loads a complete, already loaded, List of Properties (used during Read or Copy Operations)

void	ClearProperties ()
	Removes all properties in once.

Detailed Description

defines IGESSegmentedViewsVisible, Type <402> Form <19> in package IGESDraw

Permits the association of display parameters with the segments of curves in a given view

Constructor & Destructor Documentation

◆ IGESDraw_SegmentedViewsVisible()

IGESDraw_SegmentedViewsVisible::IGESDraw_SegmentedViewsVisible ( )

Member Function Documentation

◆ BreakpointParameter()

double IGESDraw_SegmentedViewsVisible::BreakpointParameter ( const int BreakpointIndex ) const

returns the parameter of the breakpoint indicated by BreakpointIndex raises an exception if BreakpointIndex <= 0 or BreakpointIndex > NbSegmentBlocks().

◆ ColorDefinition()

occ::handle< IGESGraph_Color > IGESDraw_SegmentedViewsVisible::ColorDefinition ( const int ColorIndex ) const

returns the Color definition entity indicated by ColorIndex raises an exception if ColorIndex <= 0 or ColorIndex > NbSegmentBlocks().

◆ ColorValue()

int IGESDraw_SegmentedViewsVisible::ColorValue ( const int ColorIndex ) const

returns the Color value indicated by ColorIndex raises an exception if ColorIndex <= 0 or ColorIndex > NbSegmentBlocks().

◆ DisplayFlag()

int IGESDraw_SegmentedViewsVisible::DisplayFlag ( const int FlagIndex ) const

returns the Display flag indicated by FlagIndex raises an exception if FlagIndex <= 0 or FlagIndex > NbSegmentBlocks().

◆ Init()

void IGESDraw_SegmentedViewsVisible::Init	(	const occ::handle< NCollection_HArray1< occ::handle< IGESData_ViewKindEntity > > > &	allViews,
		const occ::handle< NCollection_HArray1< double > > &	allBreakpointParameters,
		const occ::handle< NCollection_HArray1< int > > &	allDisplayFlags,
		const occ::handle< NCollection_HArray1< int > > &	allColorValues,
		const occ::handle< NCollection_HArray1< occ::handle< IGESGraph_Color > > > &	allColorDefinitions,
		const occ::handle< NCollection_HArray1< int > > &	allLineFontValues,
		const occ::handle< NCollection_HArray1< occ::handle< IGESData_LineFontEntity > > > &	allLineFontDefinitions,
		const occ::handle< NCollection_HArray1< int > > &	allLineWeights )

This method is used to set the fields of the class SegmentedViewsVisible.

allViews : Pointers to View Entities
allBreakpointParameters : Parameters of breakpoints
allDisplayFlags : Display flags
allColorValues : Color Values
allColorDefinitions : Color Definitions
allLineFontValues : LineFont values
allLineFontDefinitions : LineFont Definitions
allLineWeights : Line weights raises exception if Lengths of allViews, allBreakpointParameters, allDisplayFlags, allColorValues, allColorDefinitions, allLineFontValues, allLineFontDefinitions and allLineWeights are not same.

◆ IsColorDefinition()

bool IGESDraw_SegmentedViewsVisible::IsColorDefinition ( const int ColorIndex ) const

returns True if the ColorIndex'th value of the "theColorDefinitions" field of <me> is a pointer raises an exception if ColorIndex <= 0 or ColorIndex > NbSegmentBlocks().

◆ IsFontDefinition()

bool IGESDraw_SegmentedViewsVisible::IsFontDefinition ( const int FontIndex ) const

returns True if the FontIndex'th value of the "theLineFontDefinitions" field of <me> is a pointer raises an exception if FontIndex <= 0 or FontIndex > NbSegmentBlocks().

◆ IsSingle()

bool IGESDraw_SegmentedViewsVisible::IsSingle ( ) const

overridevirtual

Returns False (for a complex view)

Implements IGESData_ViewKindEntity.

◆ LineFontDefinition()

occ::handle< IGESData_LineFontEntity > IGESDraw_SegmentedViewsVisible::LineFontDefinition ( const int FontIndex ) const

returns the LineFont definition entity indicated by FontIndex raises an exception if FontIndex <= 0 or FontIndex > NbSegmentBlocks().

◆ LineFontValue()

int IGESDraw_SegmentedViewsVisible::LineFontValue ( const int FontIndex ) const

returns the LineFont value indicated by FontIndex raises an exception if FontIndex <= 0 or FontIndex > NbSegmentBlocks().

◆ LineWeightItem()

int IGESDraw_SegmentedViewsVisible::LineWeightItem ( const int WeightIndex ) const

returns the LineWeight value indicated by WeightIndex raises an exception if WeightIndex <= 0 or WeightIndex > NbSegmentBlocks().

◆ NbSegmentBlocks()

int IGESDraw_SegmentedViewsVisible::NbSegmentBlocks ( ) const

returns the number of view/segment blocks in <me> Similar to NbViews but has a more general significance

◆ NbViews()

int IGESDraw_SegmentedViewsVisible::NbViews ( ) const

overridevirtual

Returns the count of Views referenced by <me> (inherited)

Implements IGESData_ViewKindEntity.

◆ ViewItem()

occ::handle< IGESData_ViewKindEntity > IGESDraw_SegmentedViewsVisible::ViewItem ( const int ViewIndex ) const

overridevirtual

returns the View entity indicated by ViewIndex raises an exception if ViewIndex <= 0 or ViewIndex > NbSegmentBlocks()

Implements IGESData_ViewKindEntity.

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

IGESDraw_SegmentedViewsVisible.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IGESDraw_SegmentedViewsVisible()

Member Function Documentation

◆ BreakpointParameter()

◆ ColorDefinition()

◆ ColorValue()

◆ DisplayFlag()

◆ Init()

◆ IsColorDefinition()

◆ IsFontDefinition()

◆ IsSingle()

◆ LineFontDefinition()

◆ LineFontValue()

◆ LineWeightItem()

◆ NbSegmentBlocks()

◆ NbViews()

◆ ViewItem()