cee::ug::DataResultVisibility Class Reference

Visibility result for all parts in the geometry for one data state. More...

Public Member Functions

 DataResultVisibility ()
 Constructs an empty object. More...
 
size_t partCount () const
 Returns number of parts in this visibility result. More...
 
const DataPartVisibilitypart (size_t partIndex) const
 Returns the part at the given index. More...
 
DataPartVisibilitypart (size_t partIndex)
 Returns the part at the given index. More...
 
void addPart (DataPartVisibility *part)
 Adds a visibility part to the result visibility. More...
 
void removeAllParts ()
 Removes all visibility parts. More...
 
- Public Member Functions inherited from cee::RefCountedObject
void addRef () const
 Increments the reference count for this object. More...
 
void release () const
 Decrements the reference count for this object. More...
 
int refCount () const
 Returns the reference count for this object. More...
 
void setRefCountZero () const
 Sets the ref count to zero, but DOES NOT delete the object. More...
 
Inheritance diagram for cee::ug::DataResultVisibility:
cee::RefCountedObject

Detailed Description

Visibility result for all parts in the geometry for one data state.

The DataResultVisibility holds a collection of DataPartVisibility objects, each containing an array of boolean values defining if an element is visible or not.

The number of parts in the result visibility and in the geometry must be the same (similar to scalars, as shown below). The number of result values in each visibility part must match the number of elements in the part.

DataPartVisibility objects can be added using addPart(). Get the number of parts in the visibility result with partCount() and accessed individual parts by calling part() with the requested index. All parts can be removed using removeAllParts().

To use the visibility result, use the ModelSpec::setVisibilityResult() method.

ugModel->modelSpec().setVisibilityResult(true);
Note
The class is reference counted and can be shared between multiple result groups. Remember that since this object is reference counted it should never be created on the stack.

Constructor & Destructor Documentation

cee::ug::DataResultVisibility::DataResultVisibility ( )

Constructs an empty object.

Member Function Documentation

void cee::ug::DataResultVisibility::addPart ( DataPartVisibility part)

Adds a visibility part to the result visibility.

Number of parts must match the number of parts in the corresponding geometry.

const DataPartVisibility * cee::ug::DataResultVisibility::part ( size_t  partIndex) const

Returns the part at the given index.

DataPartVisibility * cee::ug::DataResultVisibility::part ( size_t  partIndex)

Returns the part at the given index.

size_t cee::ug::DataResultVisibility::partCount ( ) const

Returns number of parts in this visibility result.

void cee::ug::DataResultVisibility::removeAllParts ( )

Removes all visibility parts.