om::editors::base::EditorTypeFlags Class Reference

A class that encapsulates the different boolean flags that an editor type can have. More...

#include <omEditorTypeFlags.h>

Public Types
enum	Flag { UNDEFINED = 0, PUBLIC = (1 << 0), DEFAULT = PUBLIC }
	An enum that specifies the different editor type flags. More...

Public Member Functions
OM_INLINE	EditorTypeFlags ()
	Create a new editor type flags object with no flags set. More...
OM_INLINE	EditorTypeFlags (Flag flag)
	Create a new editor type flags object with the specified flag value initially set. More...
OM_INLINE	EditorTypeFlags (UInt32 newFlags)
	Create a new editor type flags object with the specified initial combined flags value. More...
OM_INLINE	operator UInt32 () const
	Convert this editor type flags object to an integer value. More...
OM_INLINE Bool	isSet (Flag flag) const
	Return whether or not the specified flag value is set for this flags object. More...
OM_INLINE void	set (Flag flag, Bool newIsSet)
	Set whether or not the specified flag value is set for this flags object. More...

Detailed Description

A class that encapsulates the different boolean flags that an editor type can have.

These flags provide boolean information about an editor type. Flags are indicated by setting a single bit of a 32-bit unsigned integer to 1.

Enum values for the different flags are defined as members of the class. Typically, the user would bitwise-OR the flag enum values together to produce a final set of set flags.

Member Enumeration Documentation

enum om::editors::base::EditorTypeFlags::Flag

An enum that specifies the different editor type flags.

Enumerator
UNDEFINED	The flag value when all flags are not set.
PUBLIC	A flag indicating whether or not the type should be visible to the user.
DEFAULT	The default flags to use for an editor type simulation.

Constructor & Destructor Documentation

OM_INLINE om::editors::base::EditorTypeFlags::EditorTypeFlags ( )

inline

Create a new editor type flags object with no flags set.

OM_INLINE om::editors::base::EditorTypeFlags::EditorTypeFlags ( Flag  flag )

inline

Create a new editor type flags object with the specified flag value initially set.

OM_INLINE om::editors::base::EditorTypeFlags::EditorTypeFlags ( UInt32  newFlags )

inline

Create a new editor type flags object with the specified initial combined flags value.

Member Function Documentation

OM_INLINE om::editors::base::EditorTypeFlags::operator UInt32 ( ) const

inline

Convert this editor type flags object to an integer value.

This operator is provided so that the AcousticFlags object can be used as an integer value for bitwise logical operations.

OM_INLINE Bool om::editors::base::EditorTypeFlags::isSet ( Flag  flag ) const

inline

Return whether or not the specified flag value is set for this flags object.

OM_INLINE void om::editors::base::EditorTypeFlags::set ( Flag  flag, Bool  newIsSet  )

inline

Set whether or not the specified flag value is set for this flags object.

---

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

• omEditorTypeFlags.h