Rhino C++ API
8.10
|
#include <rhinoSdkCommand.h>
Public Member Functions | |
CRhinoHistory (const class CRhinoHistoryRecord &) | |
CRhinoHistory (const CRhinoCommand &) | |
CRhinoHistory (const CRhinoHistory &) | |
CRhinoHistory (ON_HistoryRecord *&) | |
~CRhinoHistory () | |
bool | CopyOnReplaceObject () const |
CRhinoHistory & | operator= (const CRhinoHistory &) |
bool | SetBoolValue (int value_id, bool b) |
bool | SetBoolValues (int value_id, int count, const bool *b) |
bool | SetBrepValue (int value_id, const ON_Brep &brep) |
bool | SetColorValue (int value_id, ON_Color c) |
bool | SetColorValues (int value_id, int count, const ON_Color *c) |
bool | SetCommand (const CRhinoCommand &cmd) |
bool | SetCopyOnReplaceObject (bool bCopyOnReplaceObject) |
bool | SetCurveValue (int value_id, const ON_Curve &curve) |
bool | SetDoubleValue (int value_id, double x) |
bool | SetDoubleValues (int value_id, int count, const double *x) |
bool | SetGeometryValue (int value_id, ON_Geometry *g) |
bool | SetGeometryValues (int value_id, const ON_SimpleArray< ON_Geometry * > a) |
bool | SetHistoryVersion (int history_version) |
bool | SetIntValue (int value_id, int i) |
bool | SetIntValues (int value_id, int count, const int *i) |
bool | SetMeshValue (int value_id, const ON_Mesh &mesh) |
bool | SetObjRefValue (int value_id, const class CRhinoObjRef &objref) |
bool | SetObjRefValues (int value_id, int count, const class CRhinoObjRef *objref) |
bool | SetPointOnObjectValue (int value_id, const class CRhinoObjRef &objref, ON_3dPoint point) |
bool | SetPointValue (int value_id, ON_3dPoint p) |
bool | SetPointValues (int value_id, int count, const ON_3dPoint *P) |
bool | SetPolyEdgeValue (CRhinoDoc &doc, int value_id, const class CRhinoPolyEdge &polyedge) |
bool | SetPolyEdgeValues (CRhinoDoc &doc, int value_id, int count, const class CRhinoPolyEdge *const *polyedges) |
bool | SetStringValue (int value_id, const wchar_t *s) |
bool | SetStringValues (int value_id, const ON_ClassArray< ON_wString > &s) |
bool | SetStringValues (int value_id, int count, const wchar_t *const *s) |
bool | SetSubDEdgeChainValue (int value_id, const ON_SubDEdgeChain &subd_edge_chain) |
bool | SetSubDEdgeChainValues (int value_id, const ON_SimpleArray< const ON_SubDEdgeChain * > &a) |
bool | SetSurfaceValue (int value_id, const ON_Surface &surface) |
bool | SetUuidValue (int value_id, ON_UUID uuid) |
bool | SetUuidValues (int value_id, int count, const ON_UUID *u) |
bool | SetVectorValue (int value_id, ON_3dVector v) |
bool | SetVectorValues (int value_id, int count, const ON_3dVector *V) |
bool | SetXformValue (int value_id, ON_Xform xform) |
bool | SetXformValues (int value_id, int count, const ON_Xform *xform) |
Friends | |
class | CRhinoHistoryRecordTable |
CRhinoHistory simply manages a pointer to an ON_HistoryRecord and frees command developers from having to carefully create the CRhinoHistoryRecord pointer in a way that never leaks memory.
CRhinoHistory::~CRhinoHistory | ( | ) |
CRhinoHistory::CRhinoHistory | ( | const CRhinoHistory & | ) |
CRhinoHistory::CRhinoHistory | ( | const CRhinoCommand & | ) |
CRhinoHistory::CRhinoHistory | ( | const class CRhinoHistoryRecord & | ) |
CRhinoHistory::CRhinoHistory | ( | ON_HistoryRecord *& | ) |
bool CRhinoHistory::CopyOnReplaceObject | ( | ) | const |
12 May, 2015 - Lowell When an object is replaced and the old object has a history record with this field set, the history record is copied and attached to the new object. That allows a descendant object to continue the history linkage after it is edited. See http://mcneel.myjetbrains.com/youtrack/issue/RH-30399
CRhinoHistory& CRhinoHistory::operator= | ( | const CRhinoHistory & | ) |
bool CRhinoHistory::SetBoolValue | ( | int | value_id, |
bool | b | ||
) |
Description: For setting values when commands are creating history records. Parameters: value_id - [in] If there a value with the same input id exists, the old value is replaced. count - [in] Number of values b - [in] array of count bools i - [in] array of count ints x - [in] array of count doubles p - [in] array of count 3d points v - [in] array of count 3d vectors xform - [in] array of count xforms c - [in] array of count colors or - [in] array of count object references g - [in] array of count geometry pointers u - [in] array of uuids s - [in] string
bool CRhinoHistory::SetBoolValues | ( | int | value_id, |
int | count, | ||
const bool * | b | ||
) |
Description: For setting values when commands are creating history records. Parameters: value_id - [in] If there a value with the same input id exists, the old value is replaced. count - [in] Number of values b - [in] array of count bools i - [in] array of count ints x - [in] array of count doubles P - [in] array of count 3d points V - [in] array of count 3d vectors xform - [in] array of count xforms c - [in] array of count colors or - [in] array of count object references g - [in] array of count geometry pointers u - [in] array of uuids s - [in] array of strings
bool CRhinoHistory::SetBrepValue | ( | int | value_id, |
const ON_Brep & | brep | ||
) |
bool CRhinoHistory::SetColorValue | ( | int | value_id, |
ON_Color | c | ||
) |
bool CRhinoHistory::SetColorValues | ( | int | value_id, |
int | count, | ||
const ON_Color * | c | ||
) |
bool CRhinoHistory::SetCommand | ( | const CRhinoCommand & | cmd | ) |
Description: Set the command whos ReplayHistory override will be used to update the command's output objects if an input changes. Parameters: cmd - [in] Remarks: You can either set the command by passing it to the constructor or by using this function.
bool CRhinoHistory::SetCopyOnReplaceObject | ( | bool | bCopyOnReplaceObject | ) |
Returns: True if successful. False if m_hr is nullptr and the value could not be set.
bool CRhinoHistory::SetCurveValue | ( | int | value_id, |
const ON_Curve & | curve | ||
) |
bool CRhinoHistory::SetDoubleValue | ( | int | value_id, |
double | x | ||
) |
bool CRhinoHistory::SetDoubleValues | ( | int | value_id, |
int | count, | ||
const double * | x | ||
) |
bool CRhinoHistory::SetGeometryValue | ( | int | value_id, |
ON_Geometry * | g | ||
) |
bool CRhinoHistory::SetGeometryValues | ( | int | value_id, |
const ON_SimpleArray< ON_Geometry * > | a | ||
) |
bool CRhinoHistory::SetHistoryVersion | ( | int | history_version | ) |
Description: Specify a non-zero integer that identifies the version of this history record. The virtual ReplayHistory() functions can check this version to avoid replaying history using information created by earlier versions of the command. Parameters: history_version - [in] any non-zero integer. It is strongly suggested that something like YYYYMMDD be used. Returns: True if successful.
bool CRhinoHistory::SetIntValue | ( | int | value_id, |
int | i | ||
) |
bool CRhinoHistory::SetIntValues | ( | int | value_id, |
int | count, | ||
const int * | i | ||
) |
bool CRhinoHistory::SetMeshValue | ( | int | value_id, |
const ON_Mesh & | mesh | ||
) |
bool CRhinoHistory::SetObjRefValue | ( | int | value_id, |
const class CRhinoObjRef & | objref | ||
) |
bool CRhinoHistory::SetObjRefValues | ( | int | value_id, |
int | count, | ||
const class CRhinoObjRef * | objref | ||
) |
bool CRhinoHistory::SetPointOnObjectValue | ( | int | value_id, |
const class CRhinoObjRef & | objref, | ||
ON_3dPoint | point | ||
) |
bool CRhinoHistory::SetPointValue | ( | int | value_id, |
ON_3dPoint | p | ||
) |
bool CRhinoHistory::SetPointValues | ( | int | value_id, |
int | count, | ||
const ON_3dPoint * | P | ||
) |
bool CRhinoHistory::SetPolyEdgeValue | ( | CRhinoDoc & | doc, |
int | value_id, | ||
const class CRhinoPolyEdge & | polyedge | ||
) |
bool CRhinoHistory::SetPolyEdgeValues | ( | CRhinoDoc & | doc, |
int | value_id, | ||
int | count, | ||
const class CRhinoPolyEdge *const * | polyedges | ||
) |
bool CRhinoHistory::SetStringValue | ( | int | value_id, |
const wchar_t * | s | ||
) |
bool CRhinoHistory::SetStringValues | ( | int | value_id, |
const ON_ClassArray< ON_wString > & | s | ||
) |
bool CRhinoHistory::SetStringValues | ( | int | value_id, |
int | count, | ||
const wchar_t *const * | s | ||
) |
bool CRhinoHistory::SetSubDEdgeChainValue | ( | int | value_id, |
const ON_SubDEdgeChain & | subd_edge_chain | ||
) |
bool CRhinoHistory::SetSubDEdgeChainValues | ( | int | value_id, |
const ON_SimpleArray< const ON_SubDEdgeChain * > & | a | ||
) |
bool CRhinoHistory::SetSurfaceValue | ( | int | value_id, |
const ON_Surface & | surface | ||
) |
bool CRhinoHistory::SetUuidValue | ( | int | value_id, |
ON_UUID | uuid | ||
) |
bool CRhinoHistory::SetUuidValues | ( | int | value_id, |
int | count, | ||
const ON_UUID * | u | ||
) |
bool CRhinoHistory::SetVectorValue | ( | int | value_id, |
ON_3dVector | v | ||
) |
bool CRhinoHistory::SetVectorValues | ( | int | value_id, |
int | count, | ||
const ON_3dVector * | V | ||
) |
bool CRhinoHistory::SetXformValue | ( | int | value_id, |
ON_Xform | xform | ||
) |
bool CRhinoHistory::SetXformValues | ( | int | value_id, |
int | count, | ||
const ON_Xform * | xform | ||
) |
|
friend |