HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
DM_GeoDetail Class Reference

#include <DM_GeoDetail.h>

Public Member Functions

bool isValid () const
 
OP_NodegetObject () const
 The object this detail represents. May be NULL for guides. More...
 
OP_NodegetSop () const
 The SOP this detail represents. May be NULL. More...
 
int getNumDetails () const
 
GU_ConstDetailHandle getDetailHandle (int detail_index) const
 
UT_Matrix4D getDetailTransform (int detail_index) const
 Get the transform of the detail at 'detail_index'. More...
 
UT_Vector4D getWorldPosition (int detail_index) const
 Get the world root position of the detail at 'detail_index'. More...
 
bool isDetailSelected (int detail_index) const
 Query if the detail is selected. This only applies to DOPs. More...
 
UT_String getDescriptiveName (int detail_index) const
 Returns a descriptive (printable) name of the detail at 'detail_index'. More...
 
UT_String getDescriptivePath (int detail_index) const
 Returns a descriptive node path name of the detail at 'detail_index'. More...
 
bool areAnyLit () const
 Returns true if any of the contained details are lit. More...
 
bool areAnyUnlit () const
 Returns true if any of the contained details are unlit. More...
 
const UT_ValArray< RE_Light * > & getLights () const
 
bool hasTransparency () const
 Returns true if any of the contained details have transparency. More...
 
bool isEnabled () const
 
bool isSelectedObject () const
 Is this object currently selected at the scene level. More...
 
bool isSecondarySelected () const
 Does this object belong to the secondary selection. More...
 
bool isCurrentObject () const
 
bool isHintedObject () const
 
bool isGhostedObject () const
 
bool isPointInstanced () const
 Is this object doing point instancing of another geometry on its points. More...
 
bool isGuide () const
 Does this represent guide geometry (usually wireframe or unlit) More...
 
bool isXray () const
 
bool isGeometry () const
 Does this geometry represent user-editable geometry (ie, not a light) More...
 
bool isTemplate () const
 Is this geometry representing a templated SOP. More...
 
bool isSelectableTemplate () const
 Is this geometry representing a selectable template SOP. More...
 
bool isTargetOutput () const
 Set if the SOP is displayed, but not current. More...
 
bool isCurrentOutput () const
 Set if this SOP is the current SOP (primarily selected) More...
 
bool isTimeDependent () const
 Does this geometry vary over time. More...
 
bool showPartialSelections (GUI_DisplayOption &disp_opt) const
 Should this geometry highlight partial selections (points, prims, etc) More...
 
DM_ViewportType getViewportMask () const
 Bitfield of the viewport types this geometry can appear in. More...
 
bool getBoundingBox3D (UT_BoundingBox &bbox, const UT_Matrix3R *rot=NULL) const
 
 DM_GeoDetail ()
 
 DM_GeoDetail (const GUI_DetailLook *look)
 
 DM_GeoDetail (const DM_GeoDetail &d)
 

Detailed Description

Constructor & Destructor Documentation

DM_GeoDetail::DM_GeoDetail ( )
DM_GeoDetail::DM_GeoDetail ( const GUI_DetailLook look)
DM_GeoDetail::DM_GeoDetail ( const DM_GeoDetail d)

Member Function Documentation

bool DM_GeoDetail::areAnyLit ( ) const

Returns true if any of the contained details are lit.

bool DM_GeoDetail::areAnyUnlit ( ) const

Returns true if any of the contained details are unlit.

bool DM_GeoDetail::getBoundingBox3D ( UT_BoundingBox bbox,
const UT_Matrix3R rot = NULL 
) const

Return the bounding box of objects in the 3D viewport. May return false if the detail is not enabled, or contains no geometry. 'rot' is an option rotation matrix.

Examples:
DM/DM_SceneBoundsHook.C.
UT_String DM_GeoDetail::getDescriptiveName ( int  detail_index) const

Returns a descriptive (printable) name of the detail at 'detail_index'.

Examples:
DM/DM_InfoHook.C.
UT_String DM_GeoDetail::getDescriptivePath ( int  detail_index) const

Returns a descriptive node path name of the detail at 'detail_index'.

GU_ConstDetailHandle DM_GeoDetail::getDetailHandle ( int  detail_index) const

Returns a detail handle for one of the details contained in this geometry, where index is from 0 to getNumDetails()-1. The detail handle may be NULL.

UT_Matrix4D DM_GeoDetail::getDetailTransform ( int  detail_index) const

Get the transform of the detail at 'detail_index'.

const UT_ValArray<RE_Light *>& DM_GeoDetail::getLights ( ) const

Returns an array of RE Light objects that are illuminating this geometry. The RE_Light object contains a subset of lighting parameters for GL display.

int DM_GeoDetail::getNumDetails ( ) const

Returns the number of details this geometry has. Generally 1, but DOPs and guides can have more than 1.

Examples:
DM/DM_InfoHook.C.
OP_Node* DM_GeoDetail::getObject ( ) const

The object this detail represents. May be NULL for guides.

Examples:
DM/DM_ObjectPathHook.C.
OP_Node* DM_GeoDetail::getSop ( ) const

The SOP this detail represents. May be NULL.

DM_ViewportType DM_GeoDetail::getViewportMask ( ) const

Bitfield of the viewport types this geometry can appear in.

UT_Vector4D DM_GeoDetail::getWorldPosition ( int  detail_index) const

Get the world root position of the detail at 'detail_index'.

bool DM_GeoDetail::hasTransparency ( ) const

Returns true if any of the contained details have transparency.

bool DM_GeoDetail::isCurrentObject ( ) const

Is this object the current object at the scene level. This implies that it is also selected, but is the primary selected object for cases where only one object can be chosen (such as when diving into an object with multiple objects selected).

Examples:
DM/DM_ObjectPathHook.C.
bool DM_GeoDetail::isCurrentOutput ( ) const

Set if this SOP is the current SOP (primarily selected)

bool DM_GeoDetail::isDetailSelected ( int  detail_index) const

Query if the detail is selected. This only applies to DOPs.

bool DM_GeoDetail::isEnabled ( ) const

Check if this geometry is enabled for display. This is not the same thing as the display flag.

bool DM_GeoDetail::isGeometry ( ) const

Does this geometry represent user-editable geometry (ie, not a light)

bool DM_GeoDetail::isGhostedObject ( ) const

Is this object ghosted. When in SOPs, other objects are ghosted by default.

bool DM_GeoDetail::isGuide ( ) const

Does this represent guide geometry (usually wireframe or unlit)

bool DM_GeoDetail::isHintedObject ( ) const

Does the object have a hint on it. Normally used to indicate a previous selection or group.

bool DM_GeoDetail::isPointInstanced ( ) const

Is this object doing point instancing of another geometry on its points.

bool DM_GeoDetail::isSecondarySelected ( ) const

Does this object belong to the secondary selection.

bool DM_GeoDetail::isSelectableTemplate ( ) const

Is this geometry representing a selectable template SOP.

bool DM_GeoDetail::isSelectedObject ( ) const

Is this object currently selected at the scene level.

bool DM_GeoDetail::isTargetOutput ( ) const

Set if the SOP is displayed, but not current.

bool DM_GeoDetail::isTemplate ( ) const

Is this geometry representing a templated SOP.

bool DM_GeoDetail::isTimeDependent ( ) const

Does this geometry vary over time.

bool DM_GeoDetail::isValid ( ) const
inline
Examples:
DM/DM_InfoHook.C, and DM/DM_ObjectPathHook.C.

Definition at line 34 of file DM_GeoDetail.h.

bool DM_GeoDetail::isXray ( ) const

Does this object have the xray-flag set, or the X-ray display option set for its display set.

bool DM_GeoDetail::showPartialSelections ( GUI_DisplayOption disp_opt) const

Should this geometry highlight partial selections (points, prims, etc)


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