Rhino C++ API  8.7
Public Member Functions | Protected Member Functions | List of all members
CRhinoMeshObject Class Reference

#include <rhinoSdkMeshObject.h>

Inheritance diagram for CRhinoMeshObject:
CRhinoObject ON_Object

Public Member Functions

 CRhinoMeshObject ()
 assigns a new object UUID More...
 CRhinoMeshObject (const CRhinoMeshObject &)
 copies source object UUID More...
 CRhinoMeshObject (const ON_3dmObjectAttributes &)
 assigns a new object UUID More...
 ~CRhinoMeshObject ()
int CreateMeshes (ON::mesh_type, const ON_MeshParameters &, bool bIgnoreCustom=false) override
void DestroyMeshes (ON::mesh_type mesh_type, bool bDeleteMeshes=true) override
void Draw (CRhinoDisplayPipeline &dp) const override
 Draws object based on pipeline display attributes... More...
void DrawHighlightedSubObjects (CRhinoDisplayPipeline &) const override
void DrawSubObject (CRhinoDisplayPipeline &, ON_COMPONENT_INDEX) const override
 Draws wireframe representation of a sub object. More...
virtual void DrawV6 (class CRhinoObjectDrawContext *draw_context) const RHINO_NOEXCEPT override
 virtual CRhinoObject::DrawV6 override More...
void EnableGrips (bool bGripsOn) override
int GetHighlightedSubObjects (ON_SimpleArray< ON_COMPONENT_INDEX > &component_indices) const override
std::vector< std::shared_ptr< const ON_Mesh > > GetMeshes (ON::mesh_type mesh_type) const
 Servicing the fake-virtual function in CRhinoObject. More...
int GetMeshes (ON::mesh_type, ON_SimpleArray< const ON_Mesh * > &) const override
int GetSelectedSubObjects (ON_SimpleArray< ON_COMPONENT_INDEX > &component_indices) const override
int GetSubObjects (ON_SimpleArray< CRhinoObject * > &subObjects, const CRhinoViewport *pViewport=nullptr) const override
bool GetTightBoundingBox (ON_BoundingBox &tight_bbox, bool bGrowBox=false, const ON_Xform *xform=nullptr) const override
int GetWireframeCurves (ON_SimpleArray< ON_Curve * > &curve_list) const override
bool HighlightRequiresRedraw () const override
bool HighlightSubObject (ON_COMPONENT_INDEX component_index, bool bHighlight=true) const override
ON_Plane InitialObjectFrame (const CRhinoDoc &) const
bool IsMeshable (ON::mesh_type) const override
 Returns true if the object is capable of having a mesh of the specified type. More...
bool IsSolid () const override
bool IsSubObjectHighlighted (ON_COMPONENT_INDEX component_index) const override
 true if specified component is highlighted More...
bool IsSubObjectSelected (ON_COMPONENT_INDEX component_index) const override
const ON_MeshMesh () const
int MeshCount (ON::mesh_type mesh_type, const ON_MeshParameters *mp=0) const override
ON::object_type ObjectType () const override
CRhinoMeshObjectoperator= (const CRhinoMeshObject &)
 copies source object UUID More...
int Pick (const CRhinoPickContext &, CRhinoObjRefArray &) const override
bool PickFilter (const CRhinoGetObject &, bool) const override
int SelectSubObject (ON_COMPONENT_INDEX component_index, bool bSelect=true, bool bSynchHighlight=true, bool bPersistentSelect=false) const override
void SetMesh (ON_Mesh *)
 ~CRhinoMeshObject() will delete this mesh More...
void SetMesh (std::shared_ptr< const ON_Mesh >)
bool SetTextureCoordinates (const ON_TextureMapping &mapping, const ON_Xform *object_xform, bool bLazy=true) const override
std::shared_ptr< const ON_MeshSharedMesh () const
 Prefer this to Mesh() More...
const wchar_t * ShortDescription (bool bPlural) const override
bool SnapTo (const CRhinoSnapContext &snap_context, CRhinoSnapEvent &snap_event) const override
int UnhighlightAllSubObjects () override
 returns number of changed subobjects More...
int UnselectAllSubObjects () override
 returns number of unselected subobjects More...
- Public Member Functions inherited from CRhinoObject
 CRhinoObject ()
 assigns a new object UUID More...
 CRhinoObject (const CRhinoObject &)
 copies source object UUID More...
 CRhinoObject (const ON_3dmObjectAttributes &)
virtual ~CRhinoObject ()
virtual void AddToDocNotification ()
BOOL32 AttachAttributeUserData (ON_UserData *pUserData)
bool AttachGeometryUserData (ON_UserData *pUserData)
CRhinoObjectAttributesAttributes ()
virtual const CRhinoObjectAttributesAttributes () const
virtual void BeginTransform (CRhinoDoc &doc, bool bDeleteOriginal, bool bAddNewObjectToDoc, bool bAddTransformHistory)
virtual ON_BoundingBox BoundingBox () const
virtual ON_BoundingBox BoundingBox (const class CRhinoViewport *pViewport) const
unsigned int BrepReferenceCount () const
class CRhObjectReferenceCounter * BrepReferenceCounter (void) const
void BrepReferenceCounter_DestroyRuntimeCache (bool bDelete) const
bool BrepReferenceCounterExists () const
bool CopyHistoryOnReplace () const
BOOL32 DeleteAttributeUserData (ON_UUID userdata_uuid)
void DeleteDynamicTransform ()
virtual void DeleteFromDocNotification ()
bool DeleteGeometryUserData (ON_UUID userdata_uuid)
void DestroyMeshes (ON::mesh_type mesh_type)
void DestroyRuntimeCache (bool bDelete=true) override
 virtual ON_Object override More...
class CRhinoDocDocument () const
unsigned int DocumentRuntimeSerialNumber () const
void Draw (CRhinoViewport &) const
virtual void DrawGrips (class CRhinoDisplayPipeline &) const
virtual CRhinoObjectDuplicateRhinoObject () const
*enum ANALYSIS_MODE **bool EnableAnalysisMode (ON_UUID am_id, bool bEnable=true) const
 new way (not virtual) More...
virtual bool EnableCustomGrips (class CRhinoObjectGrips *custom_grips)
virtual void EndTransform (CRhinoDoc &doc, bool bDeleteOriginal, bool bAddNewObjectToDoc, bool bAddTransformHistory)
const ON_GeometryGeometry () const
 returns a pointer to the object's geometry More...
ON_UserDataGetAttributeUserData (ON_UUID userdata_uuid) const
bool GetDynamicTransform (ON_Xform &dynamic_xform) const
virtual bool GetFrame (ON_Plane &plane) const
ON_UserDataGetGeometryUserData (ON_UUID userdata_uuid) const
virtual int GetGrips (ON_SimpleArray< class CRhinoGripObject * > &grip_list) const
std::vector< std::shared_ptr< const ON_Mesh > > GetMeshes (ON::mesh_type mesh_type) const
void GetRenderMeshParameters (ON_MeshParameters &mp) const
virtual int GetSubobjectMaterialComponents (ON_SimpleArray< ON_COMPONENT_INDEX > &components_with_subobject_materials) const
virtual int GetSubObjects (ON_SimpleArray< CRhinoObject * > &subObjects, const class CRhinoViewport *pViewport=NULL) const
const class CRhinoGripsEnablerGripsEnabler () const
int GripsOn () const
bool GripsSelected () const
bool HasCustomRenderMeshes (ON::mesh_type mt, const ON_Viewport *vp=nullptr, ON__UINT32 *flags=nullptr, const class CRhinoPlugIn *requestingPlugIn=nullptr, const class CDisplayPipelineAttributes *pAttributes=nullptr) const
 Determine if custom render meshes will be supplied for a particular object. More...
bool HasDynamicTransform () const
virtual bool HasSubobjectMaterials (void) const
bool Highlight (bool bHighlight=true) const
const CRhinoHistoryRecordHistoryRecord () const
const ON_UUID Id () const
bool InAnalysisMode () const
bool InAnalysisMode (const ON_UUID &am_id) const
 bool AnalysisMode( ANALYSIS_MODE am ) const; ///< old way More...
ON_Plane InitialObjectFrame (const CRhinoDoc &) const
const class CRhinoVisualAnalysisModeInShadedAnalysisMode () const
unsigned int IsActiveInDocument () const
virtual bool IsActiveInViewport (const class CRhinoViewport &) const
virtual bool IsDeletable () const
bool IsDeleted () const
virtual bool IsGroupObject () const
bool IsHidden () const
int IsHighlighted (BOOL32 bCheckSubObjects=false) const
 highlighted state (almost always = IsSelected() except in one or two commands) More...
bool IsInstanceDefinitionGeometry () const
int IsInstanceDefinitionGeometryEx () const
bool IsLocked () const
int IsMarked () const
bool IsModelObject () const
bool IsNormal () const
bool IsPageObject () const
int IsProxy () const
bool IsReference () const
bool IsSelectable (bool bIgnoreSelectionState, bool bIgnoreGripsState, bool bIgnoreLocking, bool bIgnoreVisibility) const
bool IsSelectable (bool bIgnoreSelectionState=false, bool bIgnoreGripsState=false) const
int IsSelected (bool bCheckSubObjects=false) const
bool IsSubObjectSelectable (ON_COMPONENT_INDEX component_index, bool bIgnoreSelectionState=false) const
bool IsValid (ON_TextLog *text_log=nullptr) const override
bool IsVisible () const
unsigned int LinkedInstanceDefinitionSerialNumber () const
void Mark (int)
void MemoryRelocate () override
 virtual ON_Object override More...
virtual const class CDisplayPipelineAttributesMeshDisplayAttributes (int mesh_index, const ON_Mesh &mesh, const class CDisplayPipelineAttributes &display_attrs) const
const ON_ModelComponentModelComponent () const
ON_UUID ModelObjectId () const override
virtual bool ModifyAttributes (const ON_3dmObjectAttributes &new_attributes, bool bEnableUndo=true, bool bQuiet=false)
const ON_wString Name () const
ON_Color ObjectDrawColor (bool bIgnoreObjectState=false) const
ON_Color ObjectDrawColor (const CRhinoObjectAttributes &attributes, bool bIgnoreObjectState=false) const
ON_Color ObjectDrawColor (const CRhinoObjectAttributes &attributes, const ON_UUID &viewport_id, bool bIgnoreObjectState) const
ON_Plane ObjectFrame (const ON_COMPONENT_INDEX &ci, unsigned int objectframe_flags) const
const class CRhinoLayerObjectLayer () const
const class CRhinoLayerObjectLayerPtr () const
const CRhinoLinetypeObjectLinetype () const
const CRhinoLinetypeObjectLinetypePtr () const
virtual const CRhinoMaterialObjectMaterial () const
virtual const CRhinoMaterialObjectMaterial (const ON_3dmObjectAttributes &attrs) const
virtual const CRhinoMaterialObjectMaterial (const ON_COMPONENT_INDEX &ci, const ON_UUID &plugin_id=RhinoDefaultRendererId(), const ON_3dmObjectAttributes *attrs=NULL) const
 This is now the preferred version of the function. This should be used to get materials component-wise in all cases. More...
virtual const CRhinoMaterialObjectMaterial (const ON_UUID &plugin_id) const
virtual const CRhRdkMaterialObjectRdkMaterial (const ON_COMPONENT_INDEX &ci, const ON_UUID &plugin_id=RhinoDefaultRendererId(), const ON_3dmObjectAttributes *attrs=NULL) const
virtual ON_wString OnDoubleClick (const CRhinoDoubleClickContext &double_click_context) const
CRhinoObjectoperator= (const CRhinoObject &)
 copies source object UUID More...
bool PerViewportIsVisible (ON_UUID viewport_id) const
virtual bool PickFilter (const class CRhinoGetObject &, bool) const
virtual void PreDrawUpdate (CRhinoDisplayPipeline &dp) const
virtual bool PrepareToWrite (int archive_3dm_version)
virtual bool PromotePreviewMeshes (ON::mesh_type)
std::shared_ptr< const RhRdk::CustomRenderMeshes::IRenderMeshesRenderMeshes (ON::mesh_type mt, bool recursive, const ON_Viewport *vp=nullptr, const class CRhRdkObjectAncestry *ancestry_only_for_by_parent_attributes=nullptr, const CRhinoPlugIn *requestingPlugIn=nullptr, const CDisplayPipelineAttributes *pAttributes=nullptr, std::shared_ptr< const RhRdk::CustomRenderMeshes::IRenderMeshes > optional_initial_primitives=nullptr) const
 Returns a complete set of custom render meshes (primitives) for the object. Simple version with no need for flags. More...
std::shared_ptr< const RhRdk::CustomRenderMeshes::IRenderMeshesRenderMeshes (ON::mesh_type mt, const ON_Viewport *vp=nullptr, const class CRhRdkObjectAncestry *ancestry_only_for_by_parent_attributes=nullptr, ON__UINT32 *flags=nullptr, const CRhinoPlugIn *requestingPlugIn=nullptr, const CDisplayPipelineAttributes *pAttributes=nullptr, std::shared_ptr< const RhRdk::CustomRenderMeshes::IRenderMeshes > optional_initial_primitives=nullptr) const
 Returns a complete set of custom render meshes (primitives) for the object. More...
unsigned int RuntimeSerialNumber () const
int Select (bool bSelect, bool bSynchHighlight, bool bPersistentSelect, bool bIgnoreGripsState, bool bIgnoreLayerLocking, bool bIgnoreLayerVisibility) const
int Select (bool bSelect=true, bool bSynchHighlight=true, bool bPersistentSelect=true, bool bIgnoreGripsState=false) const
bool SetCachedTextureCoordinates (const ON_TextureMapping &mapping, const ON_Xform *object_xform, bool bLazy=true) const
bool SetCachedTextureCoordinatesFromPlugIn (const ON_UUID &plugin_id) const
bool SetCachedTextureCoordinatesFromPlugIn (const ON_UUID &plugin_id, const ON_SimpleArray< ON_TextureMapping::TYPE > &mappings_to_cache) const
void SetCopyHistoryOnReplace (bool bCopy) const
bool SetDynamicTransform (const ON_Xform &dynamic_xform)
bool SetHistory (class CRhinoHistory &history)
void SetObjectFrame (const ON_COMPONENT_INDEX &ci, const ON_Plane &plane)
void SetObjectFrame (const ON_COMPONENT_INDEX &ci, const ON_Xform &wcs_to_ocs)
virtual bool SetRenderMeshParameters (const ON_MeshParameters &mp)
virtual bool SetTextureCoordinatesFromPlugIn (const ON_UUID &plugin_id, int mapping_channel_id) const
virtual unsigned int SizeOf () const override
 returns number of bytes used by this particular instance More...
ON::active_space Space () const
virtual ON_ComponentStatus SubObjectStatus () const
virtual bool SupportsBrepProxyReferenceCounting () const
bool UndoModifyAttributes (unsigned int ur_sn=0)
void UpdateBoundingBox ()
virtual bool VetoTransformObject (CRhinoDoc &doc, bool bDeleteOriginal, bool bAddNewObjectToDoc, bool bAddTransformHistory) const
unsigned int WorksessionReferenceModelSerialNumber () const
- Public Member Functions inherited from ON_Object
 ON_Object (const ON_Object &)
virtual ~ON_Object ()
virtual ON_AggregateComponentStatus AggregateComponentStatus () const
bool AttachUserData (class ON_UserData *pUserData)
unsigned int ClearAllComponentStates () const
virtual unsigned int ClearComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_clear) const
virtual unsigned int ClearComponentStates (ON_ComponentStatus states_to_clear) const
void CopyUserData (const ON_Object &source_object)
unsigned int CopyUserData (const ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution)
virtual ON__UINT32 DataCRC (ON__UINT32 current_remainder) const
virtual bool DeleteComponents (const ON_COMPONENT_INDEX *ci_list, size_t ci_count)
bool DetachUserData (class ON_UserData *pUserData)
virtual void Dump (ON_TextLog &) const
void EmergencyDestroy ()
class ON_UserDataFirstUserData () const
virtual unsigned int GetComponentsWithSetStates (ON_ComponentStatus states_filter, bool bAllEqualStates, ON_SimpleArray< ON_COMPONENT_INDEX > &components) const
class ON_UserDataGetUserData (const ON_UUID &userdata_uuid) const
bool GetUserString (const wchar_t *key, ON_wString &string_value) const
int GetUserStringKeys (ON_ClassArray< ON_wString > &user_string_keys) const
int GetUserStrings (ON_ClassArray< ON_UserString > &user_strings) const
bool IsCorrupt (bool bRepair, bool bSilentError, class ON_TextLog *text_log) const
bool IsKindOf (const ON_ClassId *pClassId) const
virtual void MarkAggregateComponentStatusAsNotCurrent () const
void MoveUserData (ON_Object &source_object)
unsigned int MoveUserData (ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution, bool bDeleteAllSourceItems)
ON_Objectoperator= (const ON_Object &)
void PurgeUserData ()
virtual bool Read (ON_BinaryArchive &binary_archive)
virtual unsigned int SetComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_set) const
virtual unsigned int SetComponentStatus (ON_COMPONENT_INDEX component_index, ON_ComponentStatus status_to_copy) const
bool SetUserString (const wchar_t *key, const wchar_t *string_value)
int SetUserStrings (int count, const ON_UserString *user_strings, bool bReplace)
bool ThisIsNullptr (bool bSilentError) const
void TransformUserData (const class ON_Xform &xform)
virtual bool UpdateReferencedComponents (const class ON_ComponentManifest &source_manifest, const class ON_ComponentManifest &destination_manifest, const class ON_ManifestMap &manifest_map)
int UserStringCount () const
virtual bool Write (ON_BinaryArchive &binary_archive) const

Protected Member Functions

int SubObjectsAreHighlighted () const override
 returns number of highlighted subobjects More...
int SubObjectsAreSelected () const override
 virtual overrides to support subobject selection More...
- Protected Member Functions inherited from CRhinoObject
void Destroy ()
virtual bool InternalVirtual_IsSelectable (bool bIgnoreSelectionState, bool bIgnoreGripsState, bool bIgnoreLocking, bool bIgnoreVisibility) const
virtual bool IsSelectableWithGripsOn () const
 true if can be selected while grips are on More...
virtual void SynchAttributes ()
 light objects are special because they are not in the geometry lists More...

Additional Inherited Members

- Public Types inherited from CRhinoObject
  unknown_object_type = ON::object_type::unknown_object_type, point_object = ON::object_type::point_object, pointset_object = ON::object_type::pointset_object, curve_object = ON::object_type::curve_object,
  surface_object = ON::object_type::surface_object, polysrf_object = ON::object_type::polysrf_filter, edge_object = ON::object_type::edge_filter, polyedge_object = ON::object_type::polyedge_filter,
  loop_object = ON::object_type::loop_object, brepvertex_filter = ON::object_type::brepvertex_filter, mesh_object = ON::object_type::mesh_object, annotation_object = ON::object_type::annotation_object,
  light_object = ON::object_type::light_object, instance_reference = ON::object_type::instance_reference, grip_object = ON::object_type::grip_object, morph_control_object = ON::object_type::morph_control_object,
  subd_object = ON::object_type::subd_object, meshvertex_filter = ON::object_type::meshvertex_filter, meshedge_filter = ON::object_type::meshedge_filter, meshface_filter = ON::object_type::meshface_filter,
  meshcomponent_reference = ON::object_type::meshcomponent_reference, cage_object = ON::object_type::cage_object, hatch_object = ON::object_type::hatch_object, phantom_object = ON::object_type::phantom_object,
  extrusion_object = ON::object_type::extrusion_object, any_object = ON::object_type::any_object
enum  objectframe_flags : unsigned int { objectframe_standard = 0, objectframe_include_scale_transforms = 1, objectframe_return_unset = 2 }
- Public Types inherited from ON_Object
enum  UserDataConflictResolution : unsigned char {
  UserDataConflictResolution::destination_object = 0, UserDataConflictResolution::source_object = 1, UserDataConflictResolution::source_copycount_gt = 2, UserDataConflictResolution::source_copycount_ge = 3,
  UserDataConflictResolution::destination_copycount_gt = 4, UserDataConflictResolution::destination_copycount_ge = 5, UserDataConflictResolution::delete_item = 6
- Static Public Member Functions inherited from CRhinoObject
static const CRhinoObjectFromId (unsigned int rhino_doc_runtime_serial_number, ON_UUID rhino_object_id)
static const CRhinoObjectFromRuntimeSerialNumber (unsigned int rhino_doc_runtime_serial_number, unsigned int rhino_object_runtime_serial_number)
static unsigned int NextRuntimeObjectSerialNumber ()
- Public Attributes inherited from CRhinoObject
class CRhObjectSdkExtensionm__object_sdk_extension
const class CRhinoObjectVisualAnalysisModem_analysis_mode_list
 list of enabled analysis modes More...
CRhinoCacheHandle m_cache
class CRhinoObjectGripsm_grips
 managed by derived objects More...
unsigned char m_use_preview_mesh
- Static Public Attributes inherited from CRhinoObject
static int m_no_show_mark
- Protected Attributes inherited from CRhinoObject
ON_BoundingBox m_bbox
 world coordinate bounding box More...
unsigned char m_geomem_type
const CRhinoHistoryRecordm_history_record

Detailed Description

Copyright (c) 1993-2017 Robert McNeel & Associates. All rights reserved. Rhinoceros is a registered trademark of Robert McNeel & Associates.


For complete Rhino SDK copyright information see http://www.rhino3d.com/developer.

Constructor & Destructor Documentation

◆ CRhinoMeshObject() [1/3]

CRhinoMeshObject::CRhinoMeshObject ( )

assigns a new object UUID

◆ CRhinoMeshObject() [2/3]

CRhinoMeshObject::CRhinoMeshObject ( const ON_3dmObjectAttributes )

assigns a new object UUID

◆ ~CRhinoMeshObject()

CRhinoMeshObject::~CRhinoMeshObject ( )

◆ CRhinoMeshObject() [3/3]

CRhinoMeshObject::CRhinoMeshObject ( const CRhinoMeshObject )

copies source object UUID

Member Function Documentation

◆ CreateMeshes()

int CRhinoMeshObject::CreateMeshes ( ON::mesh_type  mesh_type,
const ON_MeshParameters mp,
bool  bIgnoreCustom = false 

Description: Create meshes used to render and analyze surface and polysurface objects. Parameters: mesh_type - [in] type of meshes to create mp - [in] in parameters that control the quality of the meshes that are created. mapping - [in] If not NULL, the texture coordinates are calculated using the call ON_Mesh::SetTextureCoordinates(*mapping,mapping,true) mapping_xform - [in] See mapping parameter description. See Also: CRhinoObject::GetMeshes CRhinoObject::MeshCount CRhinoObject::IsMeshable

Reimplemented from CRhinoObject.

◆ DestroyMeshes()

void CRhinoMeshObject::DestroyMeshes ( ON::mesh_type  mesh_type,
bool  bDeleteMeshes = true 

Description: Destroy meshes used to render and analyze surface and polysurface objects. Parameters: mesh_type - [in] type of mesh to destroy bDeleteMeshes - [in] if true, cached meshes are deleted. If false, pointers to cached meshes are just set to NULL. See Also: CRhinoObject::GetMeshes CRhinoObject::MeshCount CRhinoObject::IsMeshable

bDeleteMeshes = false is no longer supported - override this function if you are implementing CRhinoObject, but ignore the bDeleteMeshes parameter. Call the function below.

Reimplemented from CRhinoObject.

◆ Draw()

void CRhinoMeshObject::Draw ( CRhinoDisplayPipeline ) const

Draws object based on pipeline display attributes...

Reimplemented from CRhinoObject.

◆ DrawHighlightedSubObjects()

void CRhinoMeshObject::DrawHighlightedSubObjects ( CRhinoDisplayPipeline ) const

Draws wireframe representation of highlighted sub objects. objects that support subobject highlighting must override this function

Reimplemented from CRhinoObject.

◆ DrawSubObject()

void CRhinoMeshObject::DrawSubObject ( CRhinoDisplayPipeline ,
) const

Draws wireframe representation of a sub object.

Reimplemented from CRhinoObject.

◆ DrawV6()

virtual void CRhinoMeshObject::DrawV6 ( class CRhinoObjectDrawContext draw_context) const

virtual CRhinoObject::DrawV6 override

Reimplemented from CRhinoObject.

◆ EnableGrips()

void CRhinoMeshObject::EnableGrips ( bool  bGripsOn)

Description: Turns on the object's default editing grips Parameters: bDefaultGripsOn - [in] True to turn on the object's default grips. False to turn off any grips. See Also: CRhinoObject::GripsOn CRhinoObject::GetGrips

Reimplemented from CRhinoObject.

◆ GetHighlightedSubObjects()

int CRhinoMeshObject::GetHighlightedSubObjects ( ON_SimpleArray< ON_COMPONENT_INDEX > &  component_indices) const

Description: Get a list of all highlighted sub-objects Parameters: component_indices - [out] component indices of highlighted sub-objects. Returns: number of highlighted subobjects

Reimplemented from CRhinoObject.

◆ GetMeshes() [1/2]

std::vector<std::shared_ptr<const ON_Mesh> > CRhinoMeshObject::GetMeshes ( ON::mesh_type  mesh_type) const

Servicing the fake-virtual function in CRhinoObject.

◆ GetMeshes() [2/2]

int CRhinoMeshObject::GetMeshes ( ON::mesh_type  mesh_type,
ON_SimpleArray< const ON_Mesh * > &  meshes 
) const

Description: Get existing meshes used to render and analyze surface and polysurface objects. Parameters: ON::mesh_type - [in] type of mesh to get meshes - [out] meshes are appended to this array. The CRhinoObject owns these meshes so the meshes cannot be modified. Returns: Number of meshes added to meshes array See Also: CRhinoObject::DestroyMeshes CRhinoObject::MeshCount CRhinoObject::IsMeshable

Reimplemented from CRhinoObject.

◆ GetSelectedSubObjects()

int CRhinoMeshObject::GetSelectedSubObjects ( ON_SimpleArray< ON_COMPONENT_INDEX > &  component_indices) const

Description: Get a list of all selected sub-objects Parameters: component_indices - [out] component indices of selected sub-objects. Returns: number of selected subobjects

Reimplemented from CRhinoObject.

◆ GetSubObjects()

int CRhinoMeshObject::GetSubObjects ( ON_SimpleArray< CRhinoObject * > &  subObjects,
const CRhinoViewport pViewport = nullptr 
) const

◆ GetTightBoundingBox()

bool CRhinoMeshObject::GetTightBoundingBox ( ON_BoundingBox tight_bbox,
bool  bGrowBox = false,
const ON_Xform xform = nullptr 
) const

Description: Get tight bounding box of this Rhino object. Parameters: tight_bbox - [in/out] tight bounding box bGrowBox -[in] (default=false)
If true and the input tight_bbox is valid, then returned tight_bbox is the union of the input tight_bbox and the tight bounding box of this Rhino object. xform -[in] (default=NULL) If not NULL, the tight bounding box of the transformed Rhino object is calculated. The Rhino object is not modified. Returns: True if the returned tight_bbox is set to a valid bounding box.

Reimplemented from CRhinoObject.

◆ GetWireframeCurves()

int CRhinoMeshObject::GetWireframeCurves ( ON_SimpleArray< ON_Curve * > &  curve_list) const

Description: Get curves that are used to display the object's wireframe. Parameters: curve_list - [in] 3d world space wireframe curves are appended to this list. The caller is responsible for deleting the curves. Returns: Number of curves appended to the list.

Reimplemented from CRhinoObject.

◆ HighlightRequiresRedraw()

bool CRhinoMeshObject::HighlightRequiresRedraw ( ) const

true if pixels used by highlighted object differ from pixels used by highlighted object.

Reimplemented from CRhinoObject.

◆ HighlightSubObject()

bool CRhinoMeshObject::HighlightSubObject ( ON_COMPONENT_INDEX  component_index,
bool  bHighlight = true 
) const

Reimplemented from CRhinoObject.

◆ InitialObjectFrame()

ON_Plane CRhinoMeshObject::InitialObjectFrame ( const CRhinoDoc ) const

◆ IsMeshable()

bool CRhinoMeshObject::IsMeshable ( ON::mesh_type  ) const

Returns true if the object is capable of having a mesh of the specified type.

Render and Analysis mesh interface

Reimplemented from CRhinoObject.

◆ IsSolid()

bool CRhinoMeshObject::IsSolid ( ) const

Returns true if object is a closed solid otherwise false. GetMeshes may return more than one mesh to represent a solid object.

Reimplemented from CRhinoObject.

◆ IsSubObjectHighlighted()

bool CRhinoMeshObject::IsSubObjectHighlighted ( ON_COMPONENT_INDEX  component_index) const

true if specified component is highlighted

Reimplemented from CRhinoObject.

◆ IsSubObjectSelected()

bool CRhinoMeshObject::IsSubObjectSelected ( ON_COMPONENT_INDEX  component_index) const

Description: Check sub-object selection state. Parameters: component_index - [in] index of subobject to check Remarks: subobject cannot be persistently selected Returns: @untitled table false sub-object is not selected true sub-object is selected

Reimplemented from CRhinoObject.

◆ Mesh()

const ON_Mesh* CRhinoMeshObject::Mesh ( ) const

◆ MeshCount()

int CRhinoMeshObject::MeshCount ( ON::mesh_type  mesh_type,
const ON_MeshParameters mp = 0 
) const

Description: CRhinoHeaders can have several different types of meshes and different numbers of meshes. A b-rep can have a render and an analysis mesh on each face. A mesh object has a single render mesh and no analysis mesh. Curve, point, and annotation objects have no meshes. Parameters: mesh_type - [in] type of mesh to count mp - [in] if not NULL and if the object can change its mesh (like a brep), then only meshes that were created with these mesh parameters are counted. Returns: number of meshes.

Reimplemented from CRhinoObject.

◆ ObjectType()

ON::object_type CRhinoMeshObject::ObjectType ( ) const

Returns: ON::mesh_object

Implements CRhinoObject.

◆ operator=()

CRhinoMeshObject& CRhinoMeshObject::operator= ( const CRhinoMeshObject )

copies source object UUID

◆ Pick()

int CRhinoMeshObject::Pick ( const CRhinoPickContext pick_context,
CRhinoObjRefArray pick_list 
) const

Description: Expert level tool. Should not normally be used by Rhino plug-ins. Parameters: pick_list: [in/out] If object should be picked, it is appended to the pick_list Returns: Number of items added to pick_list.

Reimplemented from CRhinoObject.

◆ PickFilter()

bool CRhinoMeshObject::PickFilter ( const CRhinoGetObject ,
) const

◆ SelectSubObject()

int CRhinoMeshObject::SelectSubObject ( ON_COMPONENT_INDEX  component_index,
bool  bSelect = true,
bool  bSynchHighlight = true,
bool  bPersistentSelect = false 
) const

Description: Reports if an object can be selected. Parameters: component_index - [in] index of subobject to check bSelect - [in] (default=true) bSynchHighlight - [in] (default=true) If true, then the object is highlighted if it is selected and not highlighted if is is not selected. bPersistentSelect - [in] (default=false) Subobjects that are persistently selected stay selected when a command terminates. Returns: 0: object is not selected 1: object is selected 2: object is selected persistently Remarks: Objects that are locked, hidden, or on locked or hidden layers cannot be selected. If IsSelectableWithGripsOn() returns false, then an that object is not selectable if it has grips turned on. See Also: CRhinoDoc::UnselectAll CRhinoView::UnselectAllSubObjects

Reimplemented from CRhinoObject.

◆ SetMesh() [1/2]

void CRhinoMeshObject::SetMesh ( ON_Mesh )

~CRhinoMeshObject() will delete this mesh

◆ SetMesh() [2/2]

void CRhinoMeshObject::SetMesh ( std::shared_ptr< const ON_Mesh )

◆ SetTextureCoordinates()

bool CRhinoMeshObject::SetTextureCoordinates ( const ON_TextureMapping mapping,
const ON_Xform object_xform,
bool  bLazy = true 
) const

Description: If the object is a mesh or has existing render meshes, then this call uses mapping to set the texture coordinates. Parameters: mapping - [in] Texture mapping function used to calculate the mesh's texture coordinates. object_xform - [in] (optional) Pass if the object has been transformed after the mapping was set.
For example, if a mapping M was used to calculate the object's texture coordinates, the object was subsequently transformed by T, and for some reason you needed to use M to recalculate the original texture coordinates, then you would pass the T as object_xform. bLazy - [in] If true, then the calculation is performed only if the current mesh texture coordinates were calculated with a different mapping. Returns: True if the object's texture coordinates are set. False if the the coordinates cannot be set (the object may not have texture coordinates, like a point, or it may not have render mesh, like a new CRhinoBrepObject, or the mapping calculation may fail.

The CRinoObject::Attributes()::m_rendering_attributes and CRhinoDoc::m_texture_mapping_table has tools to get texture mappings.
See Also: ON_TextureMapping::GetTextureCoordinates ON_Mesh::SetTextureCoordinates CRhinoObject::GetTextureMapping

Reimplemented from CRhinoObject.

◆ SharedMesh()

std::shared_ptr<const ON_Mesh> CRhinoMeshObject::SharedMesh ( ) const

Prefer this to Mesh()

◆ ShortDescription()

const wchar_t* CRhinoMeshObject::ShortDescription ( bool  bPlural) const

virtual CRhinoObject override bool EnableAnalysisMode( ANALYSIS_MODE am, bool bEnable = true ) const; virtual CRhinoObject override bool SupportsAnalysisMode( ANALYSIS_MODE ) const; Returns: "mesh" or "meshes"

Implements CRhinoObject.

◆ SnapTo()

bool CRhinoMeshObject::SnapTo ( const CRhinoSnapContext snap_context,
CRhinoSnapEvent snap_event 
) const

Description: Low level tool for internal use only. See definition of CRhinoObject::SnapTo for detailed information. Remarks: This function should not be used in Rhino plug-ins.

Reimplemented from CRhinoObject.

◆ SubObjectsAreHighlighted()

int CRhinoMeshObject::SubObjectsAreHighlighted ( ) const

returns number of highlighted subobjects

Reimplemented from CRhinoObject.

◆ SubObjectsAreSelected()

int CRhinoMeshObject::SubObjectsAreSelected ( ) const

virtual overrides to support subobject selection

Reimplemented from CRhinoObject.

◆ UnhighlightAllSubObjects()

int CRhinoMeshObject::UnhighlightAllSubObjects ( )

returns number of changed subobjects

Reimplemented from CRhinoObject.

◆ UnselectAllSubObjects()

int CRhinoMeshObject::UnselectAllSubObjects ( )

returns number of unselected subobjects

Reimplemented from CRhinoObject.