MR.Const_ObjectPoints Class Reference

an object that stores a points Generated from class MR.ObjectPoints. Base classes: Direct: (non-virtual) MR.ObjectPointsHolder Indirect: (non-virtual) MR.ObjectChildrenHolder MR.Object MR.VisualObject This is the const half of the class. More...

Inheritance diagram for MR.Const_ObjectPoints:

Classes
struct	_Underlying
struct	_UnderlyingShared

Public Member Functions
virtual void	Dispose ()
unsafe	Const_ObjectPoints ()
	Constructs an empty (default-constructed) instance.
unsafe	Const_ObjectPoints (MR._ByValue_ObjectPoints _other)
	Generated from constructor MR.ObjectPoints.ObjectPoints.
unsafe	Const_ObjectPoints (MR.Const_ObjectMesh objMesh, bool? saveNormals=null)
	Generated from constructor MR.ObjectPoints.ObjectPoints. Parameter saveNormals defaults to true.
unsafe? byte	typeName ()
	Generated from method MR.ObjectPoints.typeName.
unsafe MR.Std.String	className ()
	Generated from method MR.ObjectPoints.className.
unsafe MR.Std.String	classNameInPlural ()
	Generated from method MR.ObjectPoints.classNameInPlural.
unsafe MR.Object	clone ()
	Generated from method MR.ObjectPoints.clone.
unsafe MR.Object	shallowClone ()
	Generated from method MR.ObjectPoints.shallowClone.
unsafe MR.Std.Vector_StdString	getInfoLines ()
	Generated from method MR.ObjectPoints.getInfoLines.
unsafe bool	hasVisualRepresentation ()
	Generated from method MR.ObjectPoints.hasVisualRepresentation.
unsafe bool	hasModel ()
	Generated from method MR.ObjectPoints.hasModel.
unsafe MR.Const_PointCloud	pointCloud ()
	Generated from method MR.ObjectPoints.pointCloud.
unsafe MR.PointCloudPart	pointCloudPart ()
unsafe MR.Const_VertBitSet	getSelectedPoints ()
	gets current selected points Generated from method MR.ObjectPoints.getSelectedPoints.
unsafe MR.Const_VertBitSet	getSelectedPointsOrAll ()
	returns selected points if any, otherwise returns all valid points Generated from method MR.ObjectPoints.getSelectedPointsOrAll.
unsafe ref readonly MR.Color	getSelectedVerticesColor (MR._InOpt_ViewportId id=default)
	returns colors of selected vertices Generated from method MR.ObjectPoints.getSelectedVerticesColor. Parameter id defaults to {}.
unsafe MR.Const_ViewportProperty_MRColor	getSelectedVerticesColorsForAllViewports ()
	Generated from method MR.ObjectPoints.getSelectedVerticesColorsForAllViewports.
unsafe bool	supportsVisualizeProperty (MR.Const_AnyVisualizeMaskEnum type)
	Generated from method MR.ObjectPoints.supportsVisualizeProperty.
unsafe MR.Const_VertColors	getVertsColorMap ()
	returns per-point colors of the object Generated from method MR.ObjectPoints.getVertsColorMap.
unsafe MR.Std.Vector_MRViewportMask	getAllVisualizeProperties ()
	get all visualize properties masks Generated from method MR.ObjectPoints.getAllVisualizeProperties.
unsafe MR.Const_ViewportMask	getVisualizePropertyMask (MR.Const_AnyVisualizeMaskEnum type)
	returns mask of viewports where given property is set Generated from method MR.ObjectPoints.getVisualizePropertyMask.
unsafe float	getPointSize ()
	returns size of points on screen in pixels Generated from method MR.ObjectPoints.getPointSize.
unsafe MR.Box3f	getWorldBox (MR._InOpt_ViewportId _1=default)
	returns cached bounding box of this point object in world coordinates; if you need bounding box in local coordinates please call getBoundingBox() Generated from method MR.ObjectPoints.getWorldBox. Parameter _1 defaults to {}.
unsafe ulong	numValidPoints ()
	returns cached information about the number of valid points Generated from method MR.ObjectPoints.numValidPoints.
unsafe ulong	numSelectedPoints ()
	returns cached information about the number of selected points Generated from method MR.ObjectPoints.numSelectedPoints.
unsafe ulong	heapBytes ()
	returns the amount of memory this object occupies on heap Generated from method MR.ObjectPoints.heapBytes.
unsafe int	getRenderDiscretization ()
	returns rendering discretization display each renderDiscretization-th point only, starting from 0 index, total number is numRenderingValidPoints() \detail defined by maximum rendered points number as: numValidPoints() / getMaxRenderingPoints() (rounded up) updated when setting maxRenderingPoints or changing the cloud (setting DIRTY_FACE flag) Generated from method MR.ObjectPoints.getRenderDiscretization.
unsafe ulong	numRenderingValidPoints ()
	returns count of valid points that will be rendered Generated from method MR.ObjectPoints.numRenderingValidPoints.
unsafe int	getMaxRenderingPoints ()
	returns maximal number of points that will be rendered if actual count of valid points is greater then the points will be sampled Generated from method MR.ObjectPoints.getMaxRenderingPoints.
unsafe? byte	serializeFormat ()
	returns overriden file extension used to serialize point cloud inside this object, nullptr means defaultSerializePointsFormat() Generated from method MR.ObjectPoints.serializeFormat.
unsafe bool	getVisualizeProperty (MR.Const_AnyVisualizeMaskEnum type, MR.Const_ViewportMask viewportMask)
	returns true if the property is set at least in one viewport specified by the mask Generated from method MR.ObjectPoints.getVisualizeProperty.
unsafe MR.ViewportMask	globalClippedByPlaneMask ()
	returns all viewports where this object or any of its parents is clipped by plane Generated from method MR.ObjectPoints.globalClippedByPlaneMask.
unsafe bool	globalClippedByPlane (MR.Const_ViewportMask? viewportMask=null)
	returns true if this object or any of its parents is clipped by plane in any of given viewports Generated from method MR.ObjectPoints.globalClippedByPlane. Parameter viewportMask defaults to ViewportMask.any().
unsafe ref readonly MR.Color	getFrontColor (bool? selected=null, MR._InOpt_ViewportId viewportId=default)
	returns color of object when it is selected/not-selected (depending on argument) in given viewport Generated from method MR.ObjectPoints.getFrontColor. Parameter selected defaults to true. Parameter viewportId defaults to {}.
unsafe MR.Const_ViewportProperty_MRColor	getFrontColorsForAllViewports (bool? selected=null)
	returns color of object when it is selected/not-selected (depending on argument) in all viewports Generated from method MR.ObjectPoints.getFrontColorsForAllViewports. Parameter selected defaults to true.
unsafe MR.Const_ViewportProperty_MRColor	getBackColorsForAllViewports ()
	returns backward color of object in all viewports Generated from method MR.ObjectPoints.getBackColorsForAllViewports.
unsafe ref readonly MR.Color	getBackColor (MR._InOpt_ViewportId viewportId=default)
	returns backward color of object in given viewport Generated from method MR.ObjectPoints.getBackColor. Parameter viewportId defaults to {}.
unsafe byte	getGlobalAlpha (MR._InOpt_ViewportId viewportId=default)
	returns global transparency alpha of object in given viewport Generated from method MR.ObjectPoints.getGlobalAlpha. Parameter viewportId defaults to {}.
unsafe MR.Const_ViewportProperty_UnsignedChar	getGlobalAlphaForAllViewports ()
	returns global transparency alpha of object in all viewports Generated from method MR.ObjectPoints.getGlobalAlphaForAllViewports.
unsafe uint	getDirtyFlags ()
	returns current dirty flags for the object Generated from method MR.ObjectPoints.getDirtyFlags.
unsafe void	resetDirty ()
	resets all dirty flags (except for cache flags that will be reset automatically on cache update) Generated from method MR.ObjectPoints.resetDirty.
unsafe void	resetDirtyExceptMask (uint mask)
	reset dirty flags without some specific bits (useful for lazy normals update) Generated from method MR.ObjectPoints.resetDirtyExceptMask.
unsafe MR.Box3f	getBoundingBox ()
	returns cached bounding box of this object in local coordinates Generated from method MR.ObjectPoints.getBoundingBox.
unsafe bool	getRedrawFlag (MR.Const_ViewportMask viewportMask)
	returns true if the object must be redrawn (due to dirty flags) in one of specified viewports Generated from method MR.ObjectPoints.getRedrawFlag.
unsafe bool	isPickable (MR.Const_ViewportMask? viewportMask=null)
	whether the object can be picked (by mouse) in any of given viewports Generated from method MR.ObjectPoints.isPickable. Parameter viewportMask defaults to ViewportMask.any().
unsafe MR.ColoringType	getColoringType ()
	returns the current coloring mode of the object Generated from method MR.ObjectPoints.getColoringType.
unsafe float	getShininess ()
	returns the current shininess visual value Generated from method MR.ObjectPoints.getShininess.
unsafe float	getSpecularStrength ()
	returns intensity of reflections Generated from method MR.ObjectPoints.getSpecularStrength.
unsafe float	getAmbientStrength ()
	returns intensity of non-directional light Generated from method MR.ObjectPoints.getAmbientStrength.
unsafe bool	render (MR.Const_ModelRenderParams _1)
	draws this object for visualization Returns true if something was drawn. Generated from method MR.ObjectPoints.render.
unsafe void	renderForPicker (MR.Const_ModelBaseRenderParams _1, uint _2)
	draws this object for picking Generated from method MR.ObjectPoints.renderForPicker.
unsafe void	renderUi (MR.Const_UiRenderParams params_)
	draws this object for 2d UI Generated from method MR.ObjectPoints.renderUi.
unsafe bool	useDefaultScenePropertiesOnDeserialization ()
	whether the scene-related properties should get their values from SceneColors and SceneSettings instances rather than from the input data on deserialization Generated from method MR.ObjectPoints.useDefaultScenePropertiesOnDeserialization.
unsafe MR.Std.Const_String	name ()
	Generated from method MR.ObjectPoints.name.
unsafe ref readonly MR.AffineXf3f	xf (MR._InOpt_ViewportId id=default, MR.Misc.InOut< bool >? isDef=null)
	this space to parent space transformation (to world space if no parent) for default or given viewport
unsafe MR.Const_ViewportProperty_MRAffineXf3f	xfsForAllViewports ()
	returns xfs for all viewports, combined into a single object Generated from method MR.ObjectPoints.xfsForAllViewports.
unsafe MR.AffineXf3f	worldXf (MR._InOpt_ViewportId id=default, MR.Misc.InOut< bool >? isDef=null)
	this space to world space transformation for default or specific viewport
unsafe MR.ViewportMask	globalVisibilityMask ()
	returns all viewports where this object is visible together with all its parents Generated from method MR.ObjectPoints.globalVisibilityMask.
unsafe bool	globalVisibility (MR.Const_ViewportMask? viewportMask=null)
	returns true if this object is visible together with all its parents in any of given viewports Generated from method MR.ObjectPoints.globalVisibility. Parameter viewportMask defaults to ViewportMask.any().
unsafe bool	isLocked ()
	object properties lock for UI Generated from method MR.ObjectPoints.isLocked.
unsafe bool	isParentLocked ()
	If true, the scene tree GUI doesn't allow you to drag'n'drop this object into a different parent. Defaults to false. Generated from method MR.ObjectPoints.isParentLocked.
unsafe bool	isAncestor (MR.Const_Object? ancestor)
	return true if given object is ancestor of this one, false otherwise Generated from method MR.ObjectPoints.isAncestor.
unsafe bool	isSelected ()
	Generated from method MR.ObjectPoints.isSelected.
unsafe bool	isAncillary ()
	Generated from method MR.ObjectPoints.isAncillary.
unsafe bool	isGlobalAncillary ()
	returns true if the object or any of its ancestors are ancillary Generated from method MR.ObjectPoints.isGlobalAncillary.
unsafe bool	isVisible (MR.Const_ViewportMask? viewportMask=null)
	checks whether the object is visible in any of the viewports specified by the mask (by default in any viewport) Generated from method MR.ObjectPoints.isVisible. Parameter viewportMask defaults to ViewportMask.any().
unsafe MR.ViewportMask	visibilityMask ()
	gets object visibility as bitmask of viewports Generated from method MR.ObjectPoints.visibilityMask.
unsafe void	resetRedrawFlag ()
	Generated from method MR.ObjectPoints.resetRedrawFlag.
unsafe MR.Object	cloneTree ()
	clones all tree of this object (except ancillary and unrecognized children) Generated from method MR.ObjectPoints.cloneTree.
unsafe MR.Object	shallowCloneTree ()
	clones all tree of this object (except ancillary and unrecognied children) clones only pointers to mesh, points or voxels Generated from method MR.ObjectPoints.shallowCloneTree.
unsafe MR.Box3f	getWorldTreeBox (MR._InOpt_ViewportId _1=default)
	empty box returns bounding box of this object and all children visible in given (or default) viewport in world coordinates Generated from method MR.ObjectPoints.getWorldTreeBox. Parameter _1 defaults to {}.
unsafe MR.Std.Const_Set_StdString	tags ()
	provides read-only access to the tag storage the storage is a set of unique strings Generated from method MR.ObjectPoints.tags.
unsafe bool	sameModels (MR.Const_Object other)
	Generated from method MR.ObjectPoints.sameModels.
unsafe ulong	getModelHash ()
	Generated from method MR.ObjectPoints.getModelHash.
unsafe MR.Object	getSharedPtr ()
	Generated from method MR.ObjectPoints.getSharedPtr.

Static Public Member Functions
static unsafe implicit	operator MR.Const_ObjectChildrenHolder (Const_ObjectPoints self)
static unsafe implicit	operator MR.Const_Object (Const_ObjectPoints self)
static unsafe implicit	operator MR.Const_VisualObject (Const_ObjectPoints self)
static unsafe implicit	operator MR.Const_ObjectPointsHolder (Const_ObjectPoints self)
static unsafe	operator Const_ObjectPoints? (MR.Const_Object parent)
static unsafe	operator Const_ObjectPoints? (MR.Const_VisualObject parent)
static unsafe	operator Const_ObjectPoints? (MR.Const_ObjectPointsHolder parent)
static unsafe? byte	staticTypeName ()
	Generated from method MR.ObjectPoints.StaticTypeName.
static unsafe? byte	staticClassName ()
	Generated from method MR.ObjectPoints.StaticClassName.
static unsafe? byte	staticClassNameInPlural ()
	Generated from method MR.ObjectPoints.StaticClassNameInPlural.

Protected Member Functions
unsafe void	_LateMakeShared (_Underlying *ptr)
virtual unsafe void	Dispose (bool disposing)

Properties
override unsafe bool	_IsOwning [get]
	Check if the underlying shared pointer is owning or not.
static unsafe int	MaxRenderingPointsDefault [get]
	default value for maximum rendered points number
static unsafe int	MaxRenderingPointsUnlimited [get]
	recommended value for maximum rendered points number to disable discretization
Properties inherited from MR.Misc.SharedObject< Const_ObjectPoints >
override bool	_IsOwning [get]
	This checks if the shared_ptr itself is owning or not, rather than whether we own our shared_ptr, which isn't a given. The derived classes have to implement this, since it depends on the specific shared_ptr type.
bool	_IsOwningSharedPtr [get]
	This checks if we own the underlying shared_ptr instance, regardless of whether it owns the underlying object, which is orthogonal. We repurpose _IsOwningVal for this.

Detailed Description

an object that stores a points Generated from class MR.ObjectPoints. Base classes: Direct: (non-virtual) MR.ObjectPointsHolder Indirect: (non-virtual) MR.ObjectChildrenHolder MR.Object MR.VisualObject This is the const half of the class.

Member Function Documentation

pointCloudPart()

unsafe MR.PointCloudPart MR.Const_ObjectPoints.pointCloudPart ( )

inline

Returns

the pair ( point cloud, selected points ) if any point is selected or full point cloud otherwise Generated from method MR.ObjectPoints.pointCloudPart.

worldXf()

unsafe MR.AffineXf3f MR.Const_ObjectPoints.worldXf ( MR._InOpt_ViewportId id = default, MR.Misc.InOut< bool >? isDef = null )

inline

this space to world space transformation for default or specific viewport

Parameters

isDef

receives true if the object has default transformation in this viewport (same as worldXf() returns) Generated from method MR.ObjectPoints.worldXf. Parameter id defaults to {}.

xf()

unsafe ref readonly MR.AffineXf3f MR.Const_ObjectPoints.xf ( MR._InOpt_ViewportId id = default, MR.Misc.InOut< bool >? isDef = null )

inline

this space to parent space transformation (to world space if no parent) for default or given viewport

Parameters

isDef

receives true if the object has default transformation in this viewport (same as xf() returns) Generated from method MR.ObjectPoints.xf. Parameter id defaults to {}.

---

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

• MRObjectPoints.cs