NDEVR
API Documentation
DesignInfo

Base information class for all design objects in the NDEVR property database. More...

Inheritance diagram for DesignInfo:
[legend]
Collaboration diagram for DesignInfo:
[legend]

Public Types

enum  DesignObjectType : uint01

Protected Member Functions

 DesignInfo (DesignObjectBase *base)
 Creates an new design object within the given DesignObjectBase.
 DesignInfo (uint04 index, DesignObjectBase *base)
 Sets a DesignObject up to be a pointer to an existing object in the database.
void _setDesignVisible (bool is_visible)
 Sets the spatial visibility of this design object and propagates the change through the design hierarchy.
void _setTransform (const Matrix< fltp08 > &transform)
 Sets the 4x4 transform matrix for this design object and propagates the change through the design hierarchy.

Protected Attributes

DesignObjectBasem_base = nullptr
 Pointer to the owning DesignObjectBase property database.
uint04 m_design_index = Constant<uint04>::Invalid
 Index of the parent design that owns this object.
uint04 m_index = Constant<uint04>::Invalid
 Row index of this object within the property database.

Detailed Description

Base information class for all design objects in the NDEVR property database.


Stores the index, design index, and a pointer to the underlying DesignObjectBase that holds the column-based property data. Subclasses use PropertyInterface to read and write typed properties.

Definition at line 12 of file DesignProperties.h.

Member Enumeration Documentation

◆ DesignObjectType


Enum representing the type of object a design object could be. A design object can be checked for inheritance using the isDesignType function.

Definition at line 23 of file DesignProperties.h.

Constructor & Destructor Documentation

◆ DesignInfo() [1/2]

DesignInfo::DesignInfo ( DesignObjectBase * base)
protected

Creates an new design object within the given DesignObjectBase.


This object is appended to the end of the DesignObjectBase data structure and values are setup to defaults.

Author: Tyler Parke

Date: 2018-03-22

◆ DesignInfo() [2/2]

DesignInfo::DesignInfo ( uint04 index,
DesignObjectBase * base )
protected

Sets a DesignObject up to be a pointer to an existing object in the database.


If the index is invalid behavior is undefined.

Author: Tyler Parke

Date: 2018-03-22

Member Function Documentation

◆ _setDesignVisible()

void DesignInfo::_setDesignVisible ( bool is_visible)
protected

Sets the spatial visibility of this design object and propagates the change through the design hierarchy.


Parameters
[in]is_visibleWhether the design object should be spatially visible.

◆ _setTransform()

void DesignInfo::_setTransform ( const Matrix< fltp08 > & transform)
protected

Sets the 4x4 transform matrix for this design object and propagates the change through the design hierarchy.


Parameters
[in]transformThe 4x4 transformation matrix to apply.

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